diff --git a/.eslintrc.js b/.eslintrc.js index 6b20dc82b7..2e7e063533 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -13,7 +13,7 @@ module.exports = { babelOptions: { configFile: './.babelrc' }, sourceType: 'module', }, - ignorePatterns: ['tmp/*', '!/.*', '/.next/'], + ignorePatterns: ['tmp/*', '!/.*', '/.next/', 'script/bookmarklets/*'], rules: { 'import/no-extraneous-dependencies': ['error', { packageDir: '.' }], }, 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 c651db59b5..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 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..b6f95a5090 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 @@ -120,7 +120,7 @@ jobs: github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} - name: Create pull request - uses: repo-sync/pull-request@9152b1c4aeeab247ba2ce12c5d7e693d287bf1b9 + uses: repo-sync/pull-request@65785d95a5a466e46a9d0708933a3bd51bbf9dde env: GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }} with: 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/.prettierignore b/.prettierignore index 4a66ca51fc..a82ea9ebe0 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,3 +1,4 @@ translations/ includes/ data/release-notes/ +script/bookmarklets/ 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 7adf2c01fc..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)." 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/actions/using-workflows/reusing-workflows.md b/content/actions/using-workflows/reusing-workflows.md index 293ca808eb..c3a090642a 100644 --- a/content/actions/using-workflows/reusing-workflows.md +++ b/content/actions/using-workflows/reusing-workflows.md @@ -104,7 +104,7 @@ You can define inputs and secrets, which can be passed from the caller workflow ``` {% endraw %} For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) and [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets). -1. Reference the input or secret in the reusable workflow. +1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. {% raw %} ```yaml 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/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md index e93d241ff3..cab8073c92 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @@ -385,6 +385,7 @@ Action | Description | `gist.destroy` | A gist is deleted. | `gist.visibility_change` | The visibility of a gist is changed. +{% ifversion ghec or ghes > 3.4 or ghae-issue-6724 %} ### `git` category actions | Action | Description @@ -392,6 +393,7 @@ Action | Description | `git.clone` | A repository was cloned. | `git.fetch` | Changes were fetched from a repository. | `git.push` | Changes were pushed to a repository. +{% endif %} ### `hook` category actions 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/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index d3b5b91f12..592601c3de 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -317,6 +317,8 @@ The footnote will render like this: **Note**: The position of a footnote in your Markdown does not influence where the footnote will be rendered. You can write a footnote right after your reference to the footnote, and the footnote will still render at the bottom of the Markdown. +Footnotes are not supported in wikis. + {% endtip %} {% endif %} 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/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/contributing/development.md b/contributing/development.md index 3cd1373b95..cb06604538 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -48,6 +48,10 @@ This repo has configuration for debugging with VS Code's built-in Node Debugger. For more detailed instructions, please see this [VS Code recipe](https://github.com/Microsoft/vscode-recipes/tree/master/nodemon). You can also learn more about debugging using VS Code [here](https://code.visualstudio.com/docs/editor/debugging). +### Using browser shortcuts + +The [`script/bookmarklets`](../script/bookmarklets) directory contains some browser shortcuts that can help with reviewing GitHub documentation. See [`script/bookmarklets/README.md`](../script/bookmarklets/README.md) for details. + ### Viewing a top-level table of contents While running the local server, you can visit [localhost:4000/dev-toc](http://localhost:4000/dev-toc) to view a top-level TOC of all the content in the site. This page is not available on https://docs.github.com. It was created for internal GitHub writers' use. diff --git a/data/features/README.md b/data/features/README.md index c2fca9380d..717a06510b 100644 --- a/data/features/README.md +++ b/data/features/README.md @@ -45,7 +45,7 @@ versions: ## Schema enforcement -The schema for validating the feature versioning lives in [`tests/helpers/schemas/feature-versions.js`](tests/helpers/schemas/feature-versions.js) and is exercised by [`tests/content/lint-files.js`](tests/content/lint-files.js). +The schema for validating the feature versioning lives in [`tests/helpers/schemas/feature-versions-schema.js`](/tests/helpers/schemas/feature-versions-schema.js) and is exercised by [`tests/linting/lint-files.js`](/tests/linting/lint-files.js). ## Script to remove feature tags diff --git a/data/features/blame-ignore-revs.yml b/data/features/blame-ignore-revs.yml index bf581317bb..f962aa054c 100644 --- a/data/features/blame-ignore-revs.yml +++ b/data/features/blame-ignore-revs.yml @@ -3,4 +3,4 @@ versions: fpt: '*' ghec: '*' - ghes: '>3.5' + ghes: '>3.4' 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/device-flow-is-opt-in.yml b/data/features/device-flow-is-opt-in.yml index 1d72f08d3d..543d525448 100644 --- a/data/features/device-flow-is-opt-in.yml +++ b/data/features/device-flow-is-opt-in.yml @@ -2,4 +2,5 @@ versions: fpt: '*' ghec: '*' + ghes: '>3.4' ghae: 'issue-6307' diff --git a/data/features/github-actions-in-dependency-graph.yml b/data/features/github-actions-in-dependency-graph.yml index f16edb7761..c352888955 100644 --- a/data/features/github-actions-in-dependency-graph.yml +++ b/data/features/github-actions-in-dependency-graph.yml @@ -3,4 +3,5 @@ versions: fpt: '*' ghae: 'issue-5813' + ghes: '>3.4' ghec: '*' 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/release-notes/enterprise-server/3-1/20.yml b/data/release-notes/enterprise-server/3-1/20.yml new file mode 100644 index 0000000000..d26167604c --- /dev/null +++ b/data/release-notes/enterprise-server/3-1/20.yml @@ -0,0 +1,22 @@ +date: '2022-04-20' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - Upgrading the nodes in a high availability pair with an upgrade package could cause Elasticsearch to enter an inconsistent state in some cases. + - In some cluster topologies, the command line utilities `ghe-spokesctl` and `ghe-btop` failed to run. + - Elasticsearch indices could be duplicated during a package upgrade, due to an `elasticsearch-upgrade` service running multiple times in parallel. + - The `maint_host_low` job queues were not processed, resulting in some maintenance tasks failing to run. + - When converting a user account to an organization, if the user account was an owner of the {% data variables.product.prodname_ghe_server %} enterprise account, the converted organization would incorrectly appear in the enterprise owner list. + - Creating an impersonation OAuth token using the Enterprise Administration REST API resulted in an error when an integration matching the OAuth Application ID already existed. + changes: + - When attempting to cache a value larger than the maximum allowed in Memcached, an error was raised however the key was not reported. + known_issues: + - The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues. + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with {% data variables.product.prodname_github_connect %}, issues in private and internal repositories are not included in {% data variables.product.prodname_dotcom_the_website %} search results. + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. diff --git a/data/release-notes/enterprise-server/3-2/12.yml b/data/release-notes/enterprise-server/3-2/12.yml new file mode 100644 index 0000000000..471d33f780 --- /dev/null +++ b/data/release-notes/enterprise-server/3-2/12.yml @@ -0,0 +1,23 @@ +date: '2022-04-20' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - Upgrading the nodes in a high availability pair with an upgrade package could cause Elasticsearch to enter an inconsistent state in some cases. + - In some cluster topologies, the command line utilities `ghe-spokesctl` and `ghe-btop` failed to run. + - Elasticsearch indices could be duplicated during a package upgrade, due to an `elasticsearch-upgrade` service running multiple times in parallel. + - When converting a user account to an organization, if the user account was an owner of the {% data variables.product.prodname_ghe_server %} enterprise account, the converted organization would incorrectly appear in the enterprise owner list. + - Creating an impersonation OAuth token using the Enterprise Administration REST API worked incorrectly when an integration matching the OAuth Application ID already existed. + changes: + - Configuration errors that halt a config apply run are now output to the terminal in addition to the configuration log. + - When attempting to cache a value larger than the maximum allowed in Memcached, an error was raised however the key was not reported. + - The {% data variables.product.prodname_codeql %} starter workflow no longer errors even if the default token permissions for {% data variables.product.prodname_actions %} are not used. + - If {% data variables.product.prodname_GH_advanced_security %} features are enabled on your instance, the performance of background jobs has improved when processing batches for repository contributions. + known_issues: + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with {% data variables.product.prodname_github_connect %}, issues in private and internal repositories are not included in {% data variables.product.prodname_dotcom_the_website %} search results. + - The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues. + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. diff --git a/data/release-notes/enterprise-server/3-3/7.yml b/data/release-notes/enterprise-server/3-3/7.yml new file mode 100644 index 0000000000..77f06ecc53 --- /dev/null +++ b/data/release-notes/enterprise-server/3-3/7.yml @@ -0,0 +1,31 @@ +date: '2022-04-20' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - When a manifest file was deleted from a repository, the manifest would not be removed from the repository's "Dependency graph" page. + - Resolved a regression that could lead to consistent failures to retrieve artifacts and download log archives for {% data variables.product.prodname_actions %}. In some circumstances we stopped resolving URLs for internal communications that used `localhost`, and instead incorrectly used the instance hostname. + - Upgrading the nodes in a high availability pair with an upgrade package could cause Elasticsearch to enter an inconsistent state in some cases. + - Rotated log files with the extension `.backup` would accumulate in directories containing system logs. + - In some cluster topologies, the command line utilities `ghe-spokesctl` and `ghe-btop` failed to run. + - Elasticsearch indices could be duplicated during a package upgrade, due to an `elasticsearch-upgrade` service running multiple times in parallel. + - In the pull request and commit views, rich diffs would fail to load for some files tracked by Git LFS. + - When converting a user account to an organization, if the user account was an owner of the {% data variables.product.prodname_ghe_server %} enterprise account, the converted organization would incorrectly appear in the enterprise owner list. + - Creating an impersonation OAuth token using the Enterprise Administration REST API resulted in an error when an integration matching the OAuth Application ID already existed. + - The Secret Scanning REST API would return a `500` response code when there were UTF8 characters present in a detected secret. + - Repository cache servers could serve data from non-cache locations even when the data was available in the local cache location. + changes: + - Configuration errors that halt a config apply run are now output to the terminal in addition to the configuration log. + - When attempting to cache a value larger than the maximum allowed in Memcached, an error was raised however the key was not reported. + - If {% data variables.product.prodname_GH_advanced_security %} features are enabled on your instance, the performance of background jobs has improved when processing batches for repository contributions. + known_issues: + - After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command. + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with {% data variables.product.prodname_github_connect %}, issues in private and internal repositories are not included in {% data variables.product.prodname_dotcom_the_website %} search results. + - The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues. + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. + - '{% data variables.product.prodname_actions %} storage settings cannot be validated and saved in the {% data variables.enterprise.management_console %} when "Force Path Style" is selected, and must instead be configured with the `ghe-actions-precheck` command line utility.' + - '{% data variables.product.prodname_ghe_server %} 3.3 instances installed on Azure and provisioned with 32+ CPU cores would fail to launch, due to a bug present in the current Linux kernel. [Updated: 2022-04-08]' diff --git a/data/release-notes/enterprise-server/3-4/2.yml b/data/release-notes/enterprise-server/3-4/2.yml new file mode 100644 index 0000000000..906e50aa6d --- /dev/null +++ b/data/release-notes/enterprise-server/3-4/2.yml @@ -0,0 +1,90 @@ +date: '2022-04-20' +sections: + security_fixes: + - Packages have been updated to the latest security versions. + bugs: + - Resolved a regression that could lead to consistent failures to retrieve artifacts and download log archives for {% data variables.product.prodname_actions %}. In some circumstances we stopped resolving URLs for internal communications that used `localhost`, and instead incorrectly used the instance hostname. + - When a manifest file was deleted from a repository, the manifest would not be removed from the repository's "Dependency graph" page. + - Upgrading the nodes in a high availability pair with an upgrade package could cause Elasticsearch to enter an inconsistent state in some cases. + - Rotated log files with the extension `.backup` would accumulate in directories containing system logs. + - In some cluster topologies, the command line utilities `ghe-spokesctl` and `ghe-btop` failed to run. + - Elasticsearch indices could be duplicated during a package upgrade, due to an `elasticsearch-upgrade` service running multiple times in parallel. + - Repository cache servers could serve data from non-cache locations even when the data was available in the local cache location. + - When converting a user account to an organization, if the user account was an owner of the {% data variables.product.prodname_ghe_server %} enterprise account, the converted organization would incorrectly appear in the enterprise owner list. + - The `/stafftools/users/ip_addresses/:address` page responded with a `500 Internal Server Error` when attempting to display the page for an IPv6 address. + - Creating an impersonation OAuth token using the Enterprise Administration REST API resulted in an error when an integration matching the OAuth Application ID already existed. + - | + When using SAML encrypted assertions with {% data variables.product.prodname_ghe_server %} 3.4.0 and 3.4.1, a new XML attribute `WantAssertionsEncrypted` in the `SPSSODescriptor` contains an invalid attribute for SAML metadata. IdPs that consume this SAML metadata endpoint may encounter errors when validating the SAML metadata XML schema. A fix will be available in the next patch release. [Updated: 2022-04-11] + + To work around this problem, you can take one of the two following actions. + - Reconfigure the IdP by uploading a static copy of the SAML metadata without the `WantAssertionsEncrypted` attribute. + - Copy the SAML metadata, remove `WantAssertionsEncrypted` attribute, host it on a web server, and reconfigure the IdP to point to that URL. + + changes: + - Added support for replica domain names that are more than 63 characters. + - Configuration errors that halt a config apply run are now output to the terminal in addition to the configuration log. + - If {% data variables.product.prodname_GH_advanced_security %} features are enabled on your instance, the performance of background jobs has improved when processing batches for repository contributions. + known_issues: + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with {% data variables.product.prodname_github_connect %}, issues in private and internal repositories are not included in {% data variables.product.prodname_dotcom_the_website %} search results. + - The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues. + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. + - Actions services need to be restarted after restoring appliance from backup taken on a different host. + - | + When using SAML encrypted assertions with {% data variables.product.prodname_ghe_server %} 3.4.0 and 3.4.1, a new XML attribute `WantAssertionsEncrypted` in the `SPSSODescriptor` contains an invalid attribute for SAML metadata. IdPs that consume this SAML metadata endpoint may encounter errors when validating the SAML metadata XML schema. A fix will be available in the next patch release. [Updated: 2022-04-11] + + To work around this problem, you can take one of the two following actions. + - Reconfigure the IdP by uploading a static copy of the SAML metadata without the `WantAssertionsEncrypted` attribute. + - Copy the SAML metadata, remove `WantAssertionsEncrypted` attribute, host it on a web server, and reconfigure the IdP to point to that URL. + + deprecations: + - heading: Deprecation of GitHub Enterprise Server 3.0 + notes: + - '**{% data variables.product.prodname_ghe_server %} 3.0 was discontinued on February 16, 2022**. This means that no patch releases will be made, even for critical security issues, after this date. For better performance, improved security, and new features, [upgrade to the newest version of {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.4/admin/enterprise-management/upgrading-github-enterprise-server) as soon as possible.' + - heading: Deprecation of GitHub Enterprise Server 3.1 + notes: + - '**{% data variables.product.prodname_ghe_server %} 3.1 will be discontinued on June 3, 2022**. This means that no patch releases will be made, even for critical security issues, after this date. For better performance, improved security, and new features, [upgrade to the newest version of {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.4/admin/enterprise-management/upgrading-github-enterprise-server) as soon as possible.' + + - heading: Deprecation of XenServer Hypervisor support + notes: + # https://github.com/github/docs-content/issues/4439 + - Starting in {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_ghe_server %} on XenServer was deprecated and is no longer supported. Please contact [GitHub Support](https://support.github.com) with questions or concerns. + + - heading: Deprecation of the Content Attachments API preview + notes: + # + - Due to low usage, we have deprecated the Content References API preview in {% data variables.product.prodname_ghe_server %} 3.4. The API was previously accessible with the `corsair-preview` header. Users can continue to navigate to external URLs without this API. Any registered usages of the Content References API will no longer receive a webhook notification for URLs from your registered domain(s) and we no longer return valid response codes for attempted updates to existing content attachments. + + - heading: Deprecation of the Codes of Conduct API preview + notes: + # https://github.com/github/releases/issues/1708 + - 'The Codes of Conduct API preview, which was accessible with the `scarlet-witch-preview` header, is deprecated and no longer accessible in {% data variables.product.prodname_ghe_server %} 3.4. We instead recommend using the "[Get community profile metrics](/rest/reference/repos#get-community-profile-metrics)" endpoint to retrieve information about a repository''s code of conduct. For more information, see the "[Deprecation Notice: Codes of Conduct API preview](https://github.blog/changelog/2021-10-06-deprecation-notice-codes-of-conduct-api-preview/)" in the {% data variables.product.prodname_dotcom %} changelog.' + + - heading: Deprecation of OAuth Application API endpoints and API authentication using query parameters + notes: + # https://github.com/github/releases/issues/1316 + - | + Starting with {% data variables.product.prodname_ghe_server %} 3.4, the [deprecated version of the OAuth Application API endpoints](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/#endpoints-affected) have been removed. If you encounter 404 error messages on these endpoints, convert your code to the versions of the OAuth Application API that do not have `access_tokens` in the URL. We've also disabled the use of API authentication using query parameters. We instead recommend using [API authentication in the request header](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/#changes-to-make). + + - heading: Deprecation of the CodeQL runner + notes: + # https://github.com/github/releases/issues/1632 + - The {% data variables.product.prodname_codeql %} runner is deprecated in {% data variables.product.prodname_ghe_server %} 3.4 and is no longer supported. The deprecation only affects users who use {% data variables.product.prodname_codeql %} code scanning in third party CI/CD systems; {% data variables.product.prodname_actions %} users are not affected. We strongly recommend that customers migrate to the {% data variables.product.prodname_codeql %} CLI, which is a feature-complete replacement for the {% data variables.product.prodname_codeql %} runner. For more information, see the [{% data variables.product.prodname_dotcom %} changelog](https://github.blog/changelog/2021-09-21-codeql-runner-deprecation/). + + - heading: Deprecation of custom bit-cache extensions + notes: + # https://github.com/github/releases/issues/1415 + - | + Starting in {% data variables.product.prodname_ghe_server %} 3.1, support for {% data variables.product.company_short %}'s proprietary bit-cache extensions began to be phased out. These extensions are deprecated in {% data variables.product.prodname_ghe_server %} 3.3 onwards. + + Any repositories that were already present and active on {% data variables.product.product_location %} running version 3.1 or 3.2 will have been automatically updated. + + Repositories which were not present and active before upgrading to {% data variables.product.prodname_ghe_server %} 3.3 may not perform optimally until a repository maintenance task is run and has successfully completed. + + To start a repository maintenance task manually, browse to `https:///stafftools/repositories///network` for each affected repository and click the Schedule button. + + backups: + - '{% data variables.product.prodname_ghe_server %} 3.4 requires at least [GitHub Enterprise Backup Utilities 3.4.0](https://github.com/github/backup-utils) for [Backups and Disaster Recovery](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance).' 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/deprecation-codeql-runner.md b/data/reusables/code-scanning/deprecation-codeql-runner.md index 22f942d9b6..6a10bea6b1 100644 --- a/data/reusables/code-scanning/deprecation-codeql-runner.md +++ b/data/reusables/code-scanning/deprecation-codeql-runner.md @@ -2,7 +2,7 @@ {% ifversion fpt or ghec %} -**Note:** The {% data variables.product.prodname_codeql_runner %} is being deprecated. On {% data variables.product.product_name %}, the {% data variables.product.prodname_codeql_runner %} will be supported until March 2022. You should upgrade to the latest version of [{% data variables.product.prodname_codeql_cli %}](https://github.com/github/codeql-action/releases). +**Note:** The {% data variables.product.prodname_codeql_runner %} is deprecated. On {% data variables.product.product_name %}, the {% data variables.product.prodname_codeql_runner %} was supported until March 2022. You should upgrade to the latest version of [{% data variables.product.prodname_codeql_cli %}](https://github.com/github/codeql-action/releases). {% elsif ghes > 3.3 %} 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/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/get-redirect.js b/lib/get-redirect.js index 849dbaca47..dc87b3caee 100644 --- a/lib/get-redirect.js +++ b/lib/get-redirect.js @@ -184,6 +184,12 @@ export default function getRedirect(uri, context) { // finds one string replacement that yields either a page or a redirect. function tryReplacements(prefix, suffix, { pages, redirects }) { const test = (suffix) => { + // This is a generally broad search and replace and this particular + // replacement has never been present in api documentation only enterprise + // admin documentation, so we're excluding the REST api pages + if (suffix.includes('/rest')) { + return false + } const candidateAsRedirect = prefix + suffix const candidateAsURL = '/en' + candidateAsRedirect return candidateAsRedirect in redirects || candidateAsURL in pages 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/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 463d699a28..e23ef58797 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -52,7 +52,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62,7 +62,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -146,7 +146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -157,7 +157,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 11, "node_id": "MDg6QXJ0aWZhY3QxMQ==", @@ -224,7 +224,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -234,7 +234,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -298,7 +298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -309,7 +309,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -382,7 +382,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -393,7 +393,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -461,7 +461,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -470,7 +470,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_active_caches_size_in_bytes": 3344284, "total_active_caches_count": 5 @@ -511,7 +511,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -520,7 +520,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_active_caches_size_in_bytes": 3344284, "total_active_caches_count": 5 @@ -579,7 +579,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -588,7 +588,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "repository_cache_usages": [ @@ -649,7 +649,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -659,7 +659,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "full_name": "octo-org/Hello-World", "active_caches_size_in_bytes": 2322142, @@ -703,7 +703,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -712,7 +712,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_organizations": "all", "allowed_actions": "selected", @@ -784,7 +784,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_organizations": "all", @@ -796,7 +796,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -851,7 +851,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -860,7 +860,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -931,7 +931,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -945,7 +945,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -991,7 +991,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -1000,7 +1000,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1046,7 +1046,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -1055,7 +1055,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1092,7 +1092,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -1101,7 +1101,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1178,7 +1178,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1194,7 +1194,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1231,7 +1231,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1240,7 +1240,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_repositories": "all", "allowed_actions": "selected", @@ -1312,7 +1312,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_repositories": "all", @@ -1324,7 +1324,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1379,7 +1379,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1388,7 +1388,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -1568,7 +1568,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -1582,7 +1582,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1628,7 +1628,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1637,7 +1637,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1683,7 +1683,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1692,7 +1692,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1729,7 +1729,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1738,7 +1738,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1815,7 +1815,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1831,7 +1831,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1868,7 +1868,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1877,7 +1877,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true @@ -1942,7 +1942,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "default_workflow_permissions": "read", @@ -1954,7 +1954,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2000,7 +2000,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2010,7 +2010,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled": true, "allowed_actions": "selected", @@ -2086,7 +2086,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled": true, @@ -2099,7 +2099,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2145,7 +2145,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2155,7 +2155,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "access_level": "organization" } @@ -2220,7 +2220,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_level": "organization" @@ -2232,7 +2232,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2278,7 +2278,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2288,7 +2288,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -2374,7 +2374,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -2391,7 +2391,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2448,7 +2448,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -2457,7 +2457,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "secrets": [ @@ -2518,7 +2518,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -2527,7 +2527,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2577,7 +2577,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2587,7 +2587,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2687,7 +2687,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2705,14 +2705,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2730,7 +2730,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -2780,7 +2780,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2789,7 +2789,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2853,7 +2853,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2863,7 +2863,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -2997,7 +2997,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -3011,7 +3011,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3066,7 +3066,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -3076,7 +3076,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -3135,7 +3135,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -3145,7 +3145,7 @@ }, "response": { "statusCode": "204", - "description": "Response when repository was removed from the selected list" + "description": "

    Response when repository was removed from the selected list

    " } } ], @@ -3213,7 +3213,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3223,7 +3223,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -3284,7 +3284,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3294,7 +3294,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -3353,7 +3353,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3364,7 +3364,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -3445,7 +3445,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3459,14 +3459,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3480,7 +3480,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3539,7 +3539,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3549,7 +3549,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3613,7 +3613,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3623,7 +3623,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -3684,7 +3684,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3694,7 +3694,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -3753,7 +3753,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3764,7 +3764,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -3845,7 +3845,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3859,14 +3859,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3880,7 +3880,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3939,7 +3939,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3949,7 +3949,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -4015,7 +4015,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -4024,7 +4024,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -4190,7 +4190,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4211,7 +4211,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4271,7 +4271,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4281,7 +4281,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4402,7 +4402,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4416,7 +4416,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "Expensive hardware runners", @@ -4476,7 +4476,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4485,7 +4485,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4549,7 +4549,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4559,7 +4559,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -4639,7 +4639,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -4654,7 +4654,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4709,7 +4709,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4719,7 +4719,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4774,7 +4774,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4784,7 +4784,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4848,7 +4848,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4858,7 +4858,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -4977,7 +4977,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -4992,7 +4992,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5047,7 +5047,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -5057,7 +5057,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5112,7 +5112,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -5122,7 +5122,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5186,7 +5186,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -5195,7 +5195,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -5366,7 +5366,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -5387,7 +5387,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -5448,7 +5448,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5458,7 +5458,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -5580,7 +5580,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -5594,7 +5594,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -5655,7 +5655,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5664,7 +5664,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5728,7 +5728,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5738,7 +5738,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -6045,7 +6045,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -6060,7 +6060,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6115,7 +6115,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6125,7 +6125,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6180,7 +6180,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6190,7 +6190,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6254,7 +6254,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6264,7 +6264,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6383,7 +6383,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -6398,7 +6398,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6453,7 +6453,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6463,7 +6463,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6518,7 +6518,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6528,7 +6528,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6585,7 +6585,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6594,7 +6594,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6689,7 +6689,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6698,7 +6698,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -6767,7 +6767,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6776,7 +6776,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -6817,7 +6817,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6826,7 +6826,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -6876,7 +6876,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6886,7 +6886,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -6961,7 +6961,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6970,7 +6970,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7016,7 +7016,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -7026,7 +7026,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -7117,7 +7117,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -7133,7 +7133,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -7228,7 +7228,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -7244,7 +7244,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -7323,7 +7323,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -7333,7 +7333,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "labels": [ @@ -7416,7 +7416,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -7427,7 +7427,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -7515,7 +7515,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -7524,7 +7524,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -7619,7 +7619,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -7628,7 +7628,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -7697,7 +7697,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -7706,7 +7706,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -7747,7 +7747,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -7756,7 +7756,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -7806,7 +7806,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -7816,7 +7816,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -7891,7 +7891,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -7900,7 +7900,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7946,7 +7946,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -7956,7 +7956,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -8047,7 +8047,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -8063,7 +8063,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -8158,7 +8158,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -8174,7 +8174,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -8253,7 +8253,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -8263,7 +8263,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "labels": [ @@ -8342,7 +8342,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -8353,7 +8353,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -8450,7 +8450,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8460,7 +8460,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -8564,7 +8564,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8574,7 +8574,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -8652,7 +8652,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8662,7 +8662,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -8712,7 +8712,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8722,7 +8722,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -8781,7 +8781,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8792,7 +8792,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -8876,7 +8876,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8886,7 +8886,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8941,7 +8941,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8952,7 +8952,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -9052,7 +9052,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -9069,7 +9069,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -9173,7 +9173,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -9190,7 +9190,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -9278,7 +9278,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9289,7 +9289,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "labels": [ @@ -9377,7 +9377,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9389,7 +9389,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -9479,7 +9479,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9490,7 +9490,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 399444496, "run_id": 29679449, @@ -9651,7 +9651,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9661,7 +9661,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9743,7 +9743,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9755,7 +9755,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "jobs": [ @@ -9957,7 +9957,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9968,7 +9968,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "jobs": [ @@ -10136,7 +10136,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10146,7 +10146,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10293,7 +10293,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10303,7 +10303,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -10591,7 +10591,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10602,7 +10602,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 30433642, "name": "Build", @@ -10875,7 +10875,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10885,7 +10885,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10940,7 +10940,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10951,7 +10951,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "state": "approved", @@ -11043,7 +11043,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11053,7 +11053,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11135,7 +11135,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11147,7 +11147,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 30433642, "name": "Build", @@ -11429,7 +11429,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11440,7 +11440,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11495,7 +11495,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11505,7 +11505,7 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11564,7 +11564,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11574,7 +11574,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11629,7 +11629,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11639,7 +11639,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11702,7 +11702,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11713,7 +11713,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "environment": { @@ -11873,7 +11873,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11884,7 +11884,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -11979,7 +11979,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11989,7 +11989,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12044,7 +12044,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12054,7 +12054,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12109,7 +12109,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12120,7 +12120,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "billable": { "UBUNTU": { @@ -12330,7 +12330,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12341,7 +12341,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -12630,7 +12630,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12640,7 +12640,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "workflows": [ @@ -12731,7 +12731,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12742,7 +12742,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", @@ -12816,7 +12816,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12826,7 +12826,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12912,7 +12912,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -12929,7 +12929,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12991,7 +12991,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13001,7 +13001,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13063,7 +13063,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13074,7 +13074,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "billable": { "UBUNTU": { @@ -13137,12 +13137,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13218,7 +13218,7 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13227,7 +13227,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13298,7 +13298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -13306,7 +13306,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13370,7 +13370,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13379,7 +13379,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13434,7 +13434,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -13442,7 +13442,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13506,7 +13506,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -13515,7 +13515,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13570,7 +13570,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -13578,7 +13578,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13633,7 +13633,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -13641,7 +13641,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13696,7 +13696,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -13704,7 +13704,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13733,13 +13733,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", @@ -13875,13 +13875,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -14031,24 +14031,24 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -14101,7 +14101,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -14110,7 +14110,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": "1", "repository": { @@ -14243,7 +14243,7 @@ { "key": "205", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -14251,7 +14251,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -14296,7 +14296,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -14305,7 +14305,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -14374,7 +14374,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -14383,7 +14383,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -14440,7 +14440,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -14448,7 +14448,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14564,7 +14564,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14574,7 +14574,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -14718,7 +14718,7 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14727,14 +14727,14 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14743,7 +14743,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -14813,7 +14813,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14823,7 +14823,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "login": "octocat", @@ -14851,7 +14851,7 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14861,7 +14861,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -14964,13 +14964,13 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -15101,13 +15101,13 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/vnd.github.v3.star+json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -15293,7 +15293,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15302,7 +15302,7 @@ }, "response": { "statusCode": "204", - "description": "Response if this repository is starred by you" + "description": "

    Response if this repository is starred by you

    " } } ], @@ -15364,7 +15364,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15373,7 +15373,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15435,7 +15435,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15444,7 +15444,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15543,7 +15543,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -15552,7 +15552,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -15743,7 +15743,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15753,7 +15753,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -15821,7 +15821,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15831,7 +15831,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if you subscribe to the repository", + "description": "

    if you subscribe to the repository

    ", "example": { "subscribed": true, "ignored": false, @@ -15913,7 +15913,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15923,7 +15923,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -15977,7 +15977,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15986,7 +15986,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16032,13 +16032,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -16211,7 +16211,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -16220,7 +16220,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -16356,13 +16356,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -16440,7 +16440,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "code": "CODE" @@ -16449,7 +16449,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -16567,13 +16567,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "The permissions the installation has are included under the `permissions` key.", + "description": "

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

    ", "example": [ { "id": 1, @@ -16667,7 +16667,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -16676,7 +16676,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -16772,7 +16772,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -16780,7 +16780,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17664,7 +17664,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "respoitory": "Hello-World", @@ -17680,7 +17680,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", @@ -17872,7 +17872,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -17880,7 +17880,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17926,7 +17926,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -17934,7 +17934,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17975,7 +17975,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "app_slug": "APP_SLUG" @@ -17984,7 +17984,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -18070,7 +18070,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -18079,7 +18079,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -18175,7 +18175,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18185,7 +18185,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -18280,7 +18280,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -18289,7 +18289,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -18388,13 +18388,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -18556,12 +18556,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -18607,13 +18607,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "You can find the permissions for the installation under the `permissions` key.", + "description": "

    You can find the permissions for the installation under the permissions key.

    ", "example": { "total_count": 2, "installations": [ @@ -18790,7 +18790,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -18799,7 +18799,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "description": "

    The access the user has to each repository is included in the hash under the permissions key.

    ", "example": { "total_count": 1, "repositories": [ @@ -18990,7 +18990,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -18999,7 +18999,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19062,7 +19062,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -19071,7 +19071,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19122,7 +19122,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "account_id": "ACCOUNT_ID" @@ -19131,7 +19131,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/github", "type": "Organization", @@ -19242,13 +19242,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/marketplace_listing/plans/1313", @@ -19358,7 +19358,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "plan_id": "PLAN_ID" @@ -19367,7 +19367,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/orgs/github", @@ -19474,7 +19474,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "account_id": "ACCOUNT_ID" @@ -19483,7 +19483,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/github", "type": "Organization", @@ -19594,13 +19594,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/marketplace_listing/plans/1313", @@ -19706,7 +19706,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "plan_id": "PLAN_ID" @@ -19715,7 +19715,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/orgs/github", @@ -19823,13 +19823,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "billing_cycle": "monthly", @@ -19924,13 +19924,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "billing_cycle": "monthly", @@ -20030,7 +20030,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -20041,7 +20041,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20098,7 +20098,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -20110,7 +20110,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -20213,7 +20213,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -20225,7 +20225,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -20324,7 +20324,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -20335,7 +20335,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -21255,7 +21255,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", @@ -21273,7 +21273,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -21389,13 +21389,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -21486,7 +21486,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content_type": "json", @@ -21498,7 +21498,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -21550,13 +21550,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -21629,7 +21629,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -21638,7 +21638,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -21726,7 +21726,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -21734,7 +21734,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -21782,7 +21782,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -21791,7 +21791,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_minutes_used": 305, "total_paid_minutes_used": 0, @@ -21856,7 +21856,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -21865,7 +21865,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Success", + "description": "

    Success

    ", "example": { "total_advanced_security_committers": 2, "repositories": [ @@ -21935,7 +21935,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -21944,7 +21944,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, @@ -21986,7 +21986,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -21995,7 +21995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, @@ -22037,7 +22037,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -22046,7 +22046,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_minutes_used": 305, "total_paid_minutes_used": 0, @@ -22093,7 +22093,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -22102,7 +22102,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, @@ -22144,7 +22144,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -22153,7 +22153,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, @@ -22182,6 +22182,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -22235,7 +22236,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22245,7 +22246,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "master", @@ -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", @@ -22325,7 +22326,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22335,7 +22336,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -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", @@ -22410,7 +22411,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "my_renamed_branch" @@ -22424,7 +22425,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "master", "commit": { @@ -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", @@ -22593,7 +22594,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "branch": "main" @@ -22606,7 +22607,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The branch has been successfully synced with the upstream repository", + "description": "

    The branch has been successfully synced with the upstream repository

    ", "example": { "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", "merge_type": "fast-forward", @@ -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", @@ -22694,7 +22695,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base": "master", @@ -22709,7 +22710,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Successful Response (The resulting merge commit)", + "description": "

    Successful Response (The resulting merge commit)

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -22835,8 +22836,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -22883,7 +22883,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22894,7 +22894,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", "required_status_checks": { @@ -23894,7 +23894,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "required_status_checks": { @@ -23950,7 +23950,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -24018,7 +24018,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24028,7 +24028,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -24088,7 +24088,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24099,7 +24099,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -24159,7 +24159,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24170,7 +24170,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -24230,7 +24230,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24240,7 +24240,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -24300,7 +24300,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24311,7 +24311,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -24579,7 +24579,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "dismissal_restrictions": { @@ -24611,7 +24611,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -24720,7 +24720,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24730,7 +24730,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -24790,7 +24790,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24801,7 +24801,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -24865,7 +24865,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24876,7 +24876,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -24940,7 +24940,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24950,7 +24950,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -25010,7 +25010,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25021,7 +25021,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -25174,7 +25174,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "strict": true, @@ -25191,7 +25191,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -25263,7 +25263,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25273,7 +25273,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -25329,7 +25329,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25340,7 +25340,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -25417,7 +25417,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25428,7 +25428,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci", "continuous-integration/jenkins" @@ -25514,7 +25514,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25525,7 +25525,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -25606,7 +25606,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25617,7 +25617,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -25684,7 +25684,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25695,7 +25695,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", @@ -25836,7 +25836,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25846,7 +25846,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -25902,7 +25902,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25913,7 +25913,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -26030,7 +26030,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26041,7 +26041,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -26158,7 +26158,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26169,7 +26169,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -26286,7 +26286,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26297,7 +26297,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -26400,7 +26400,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26411,7 +26411,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -26501,7 +26501,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26512,7 +26512,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -26602,7 +26602,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26613,7 +26613,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -26703,7 +26703,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26714,7 +26714,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -26790,7 +26790,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26801,7 +26801,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -26897,7 +26897,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26908,7 +26908,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -27004,7 +27004,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27015,7 +27015,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -27111,7 +27111,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27122,7 +27122,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -28150,7 +28150,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Example of an in_progress conclusion", + "description": "

    Example of an in_progress conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -28172,7 +28172,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "

    Response for in_progress conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -28269,7 +28269,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Example of a completed conclusion", + "description": "

    Example of a completed conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -28325,7 +28325,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "

    Response for completed conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -28470,7 +28470,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28481,7 +28481,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -29567,7 +29567,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -29616,7 +29616,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -29779,7 +29779,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29790,7 +29790,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "path": "README.md", @@ -29859,7 +29859,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29869,7 +29869,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -29991,7 +29991,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30002,7 +30002,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -30217,7 +30217,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30228,7 +30228,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -30382,7 +30382,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -30395,7 +30395,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the suite already exists", + "description": "

    Response when the suite already exists

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -30702,7 +30702,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -30715,7 +30715,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the suite was created", + "description": "

    Response when the suite was created

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -31131,7 +31131,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "auto_trigger_checks": [ @@ -31149,7 +31149,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "preferences": { "auto_trigger_checks": [ @@ -31443,7 +31443,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31454,7 +31454,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -31809,7 +31809,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31819,7 +31819,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -31912,7 +31912,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31923,7 +31923,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_suites": [ @@ -32226,7 +32226,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -32235,7 +32235,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 4, @@ -32950,7 +32950,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32960,7 +32960,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 4, @@ -33146,7 +33146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33157,7 +33157,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-06-19T11:21:34Z", @@ -33345,7 +33345,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", @@ -33361,7 +33361,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-08-25T21:28:36Z", @@ -33527,7 +33527,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33538,7 +33538,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -33705,7 +33705,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33715,7 +33715,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -33826,7 +33826,7 @@ { "key": "response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33837,7 +33837,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "ref": "refs/heads/main", "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", @@ -33937,7 +33937,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33948,7 +33948,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" @@ -34078,7 +34078,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34088,7 +34088,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -34167,7 +34167,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34178,7 +34178,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "processing_status": "complete", "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -34225,13 +34225,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "citizen_code_of_conduct", @@ -34286,7 +34286,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key": "KEY" @@ -34295,7 +34295,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "contributor_covenant", "name": "Contributor Covenant", @@ -34378,7 +34378,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34388,7 +34388,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "codespaces": [ @@ -34797,7 +34797,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, @@ -34811,7 +34811,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the codespace was successfully created", + "description": "

    Response when the codespace was successfully created

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -34962,7 +34962,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, @@ -34976,7 +34976,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response when the codespace creation partially failed but is being retried in the background", + "description": "

    Response when the codespace creation partially failed but is being retried in the background

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -35238,7 +35238,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, @@ -35253,7 +35253,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the codespace was successfully created", + "description": "

    Response when the codespace was successfully created

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -35404,7 +35404,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, @@ -35419,7 +35419,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response when the codespace creation partially failed but is being retried in the background", + "description": "

    Response when the codespace creation partially failed but is being retried in the background

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -35633,13 +35633,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "codespaces": [ @@ -36244,7 +36244,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, @@ -36255,7 +36255,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the codespace was successfully created", + "description": "

    Response when the codespace was successfully created

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -36406,7 +36406,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, @@ -36417,7 +36417,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response when the codespace creation partially failed but is being retried in the background", + "description": "

    Response when the codespace creation partially failed but is being retried in the background

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -36614,7 +36614,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" @@ -36623,7 +36623,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -36856,7 +36856,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "machine": "standardLinux" @@ -36868,7 +36868,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -37061,7 +37061,7 @@ { "key": "202", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" @@ -37069,7 +37069,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -37126,7 +37126,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" @@ -37135,7 +37135,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "state": "succeeded", "completed_at": "2022-01-01T14:59:22Z", @@ -37209,7 +37209,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME", @@ -37219,7 +37219,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "state": "succeeded", "completed_at": "2022-01-01T14:59:22Z", @@ -37268,7 +37268,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" @@ -37277,7 +37277,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -37490,7 +37490,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" @@ -37499,7 +37499,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", @@ -37719,7 +37719,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37729,7 +37729,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "machines": [ @@ -37807,7 +37807,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" @@ -37816,7 +37816,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "machines": [ @@ -37923,7 +37923,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37933,7 +37933,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -37994,7 +37994,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38004,7 +38004,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -38063,7 +38063,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38074,7 +38074,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -38155,7 +38155,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -38169,14 +38169,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -38190,7 +38190,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -38249,7 +38249,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38259,7 +38259,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38307,13 +38307,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -38355,13 +38355,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -38402,7 +38402,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" @@ -38411,7 +38411,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "CODESPACE_GH_SECRET", "created_at": "2019-08-10T14:59:22Z", @@ -38488,7 +38488,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -38504,14 +38504,14 @@ }, "response": { "statusCode": "201", - "description": "Response after successfully creaing a secret" + "description": "

    Response after successfully creaing a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -38527,7 +38527,7 @@ }, "response": { "statusCode": "204", - "description": "Response after successfully updating a secret" + "description": "

    Response after successfully updating a secret

    " } } ], @@ -38576,7 +38576,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" @@ -38584,7 +38584,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38621,7 +38621,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" @@ -38630,7 +38630,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -38943,7 +38943,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -38957,7 +38957,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repositories were added to the selected list" + "description": "

    No Content when repositories were added to the selected list

    " } } ], @@ -39019,7 +39019,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME", @@ -39028,7 +39028,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -39090,7 +39090,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME", @@ -39099,7 +39099,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was removed from the selected list" + "description": "

    No Content when repository was removed from the selected list

    " } } ], @@ -39138,6 +39138,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39197,7 +39198,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39207,7 +39208,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -39252,8 +39253,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://api.github.com", @@ -39261,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", @@ -39296,7 +39297,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39306,7 +39307,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a collaborator" + "description": "

    Response if user is a collaborator

    " } } ], @@ -39321,8 +39322,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://api.github.com", @@ -39330,6 +39330,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39395,7 +39396,7 @@ "key": "response-when-a-new-invitation-is-created", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39406,7 +39407,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when a new invitation is created", + "description": "

    Response when a new invitation is created

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -39546,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", @@ -39555,6 +39555,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39590,7 +39591,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39600,7 +39601,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39611,8 +39612,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://api.github.com", @@ -39620,6 +39620,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39655,7 +39656,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39666,7 +39667,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if user has admin permissions", + "description": "

    if user has admin permissions

    ", "example": { "permission": "admin", "role_name": "admin", @@ -39705,8 +39706,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -39761,7 +39761,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39771,7 +39771,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -39963,7 +39963,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39974,7 +39974,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -40147,7 +40147,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40157,7 +40157,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40203,13 +40203,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -40381,7 +40381,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -40389,7 +40389,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40442,7 +40442,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -40450,7 +40450,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40489,6 +40489,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -40580,7 +40581,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40590,7 +40591,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -40697,8 +40698,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://api.github.com", @@ -40706,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", @@ -40742,7 +40743,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40753,7 +40754,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "branch_5", @@ -40778,8 +40779,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://api.github.com", @@ -40787,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", @@ -40841,7 +40842,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40852,7 +40853,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -41383,8 +41384,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://api.github.com", @@ -41392,6 +41392,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -41446,7 +41447,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41457,7 +41458,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -41575,8 +41576,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://api.github.com", @@ -41584,6 +41584,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -41637,7 +41638,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41648,7 +41649,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", @@ -41928,8 +41929,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -41984,7 +41984,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41994,7 +41994,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -42085,7 +42085,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42096,7 +42096,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -42200,7 +42200,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Nice change" @@ -42214,7 +42214,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -42307,7 +42307,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42317,7 +42317,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42395,7 +42395,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42406,7 +42406,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -42536,7 +42536,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff", @@ -42553,7 +42553,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -42671,7 +42671,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42682,7 +42682,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "state": "success", "statuses": [ @@ -42862,7 +42862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42873,7 +42873,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -43012,7 +43012,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "success", @@ -43029,7 +43029,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", @@ -43120,7 +43120,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -43129,7 +43129,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "secrets": [ @@ -43190,7 +43190,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -43199,7 +43199,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -43249,7 +43249,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -43259,7 +43259,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "NPM_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -43359,7 +43359,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -43377,14 +43377,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -43402,7 +43402,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -43452,7 +43452,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -43461,7 +43461,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -43525,7 +43525,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -43535,7 +43535,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -43669,7 +43669,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -43683,7 +43683,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -43738,7 +43738,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -43748,7 +43748,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -43807,7 +43807,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -43817,7 +43817,7 @@ }, "response": { "statusCode": "204", - "description": "Response when repository was removed from the selected list" + "description": "

    Response when repository was removed from the selected list

    " } } ], @@ -43885,7 +43885,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43895,7 +43895,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -43956,7 +43956,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43966,7 +43966,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -44025,7 +44025,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44036,7 +44036,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "MY_ARTIFACTORY_PASSWORD", "created_at": "2019-08-10T14:59:22Z", @@ -44117,7 +44117,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -44131,14 +44131,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -44152,7 +44152,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -44211,7 +44211,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44221,7 +44221,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -44288,7 +44288,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44299,7 +44299,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "change_type": "removed", @@ -44364,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", @@ -44417,7 +44416,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44427,7 +44426,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -44449,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", @@ -44513,7 +44512,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "octocat@octomac", @@ -44528,7 +44527,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -44552,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", @@ -44596,7 +44595,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44607,7 +44606,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -44631,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", @@ -44675,7 +44674,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44685,7 +44684,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -44696,7 +44695,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -44708,6 +44708,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -44795,7 +44796,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44805,7 +44806,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -44856,8 +44857,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://api.github.com", @@ -44865,6 +44865,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -44994,7 +44995,7 @@ "key": "simple-example", "request": { "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -45009,7 +45010,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -45070,8 +45071,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://api.github.com", @@ -45079,6 +45079,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -45114,7 +45115,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45125,7 +45126,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -45178,8 +45179,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://api.github.com", @@ -45187,6 +45187,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -45222,7 +45223,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45232,7 +45233,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -45251,8 +45252,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -45307,7 +45307,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45317,7 +45317,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "environments": [ @@ -45450,7 +45450,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45461,7 +45461,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -45746,7 +45746,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45757,7 +45757,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -45889,7 +45889,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45899,7 +45899,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -45974,7 +45974,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45985,7 +45985,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", @@ -46164,7 +46164,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "environment": "production", @@ -46181,7 +46181,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -46284,7 +46284,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46296,7 +46296,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -46365,12 +46365,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46488,7 +46488,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -46497,7 +46497,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "@timestamp": 1606929874512, @@ -46566,7 +46566,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -46575,7 +46575,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_minutes_used": 305, "total_paid_minutes_used": 0, @@ -46640,7 +46640,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -46649,7 +46649,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Success", + "description": "

    Success

    ", "example": { "total_advanced_security_committers": 2, "repositories": [ @@ -46719,7 +46719,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -46728,7 +46728,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, @@ -46770,7 +46770,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -46779,7 +46779,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, @@ -46859,7 +46859,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -46868,7 +46868,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" @@ -47027,7 +47027,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -47050,7 +47050,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -47131,7 +47131,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -47141,7 +47141,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -47278,7 +47278,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -47302,7 +47302,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -47478,7 +47478,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -47504,7 +47504,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -47571,7 +47571,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -47580,7 +47580,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -47644,7 +47644,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -47653,7 +47653,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" @@ -47958,7 +47958,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -47989,7 +47989,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" @@ -48066,7 +48066,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -48076,7 +48076,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" @@ -48353,7 +48353,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -48385,7 +48385,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" @@ -48488,7 +48488,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -48520,7 +48520,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" @@ -48601,7 +48601,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -48610,7 +48610,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -48669,13 +48669,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -48830,13 +48830,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -48923,13 +48923,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -49046,13 +49046,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -49150,7 +49150,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49159,7 +49159,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -49289,7 +49289,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49298,7 +49298,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -49358,7 +49358,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49366,7 +49366,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49433,7 +49433,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49442,7 +49442,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", @@ -49541,7 +49541,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49550,7 +49550,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -49647,7 +49647,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49656,7 +49656,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -49756,7 +49756,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49764,7 +49764,7 @@ }, "response": { "statusCode": "204", - "description": "Response if gist is starred" + "description": "

    Response if gist is starred

    " } } ], @@ -49813,7 +49813,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49821,7 +49821,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49870,7 +49870,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -49878,7 +49878,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49936,7 +49936,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -49946,7 +49946,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -50038,7 +50038,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -50047,7 +50047,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -50158,7 +50158,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -50167,7 +50167,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -50262,7 +50262,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -50271,7 +50271,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -50358,7 +50358,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -50368,7 +50368,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -50470,7 +50470,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -50480,7 +50480,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -50559,7 +50559,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -50568,7 +50568,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50651,7 +50651,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "Content of the blob", @@ -50665,7 +50665,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" @@ -50740,7 +50740,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50751,7 +50751,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", "encoding": "base64", @@ -51014,7 +51014,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -51037,7 +51037,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -51135,7 +51135,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51146,7 +51146,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", @@ -51260,7 +51260,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51271,7 +51271,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/feature-a", @@ -51349,7 +51349,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51360,7 +51360,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -51451,7 +51451,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "refs/heads/featureA", @@ -51465,7 +51465,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -51556,7 +51556,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", @@ -51571,7 +51571,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -51641,7 +51641,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51651,7 +51651,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51825,7 +51825,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag": "v0.0.1", @@ -51846,7 +51846,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -51928,7 +51928,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51939,7 +51939,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -52167,7 +52167,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -52188,7 +52188,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", @@ -52280,7 +52280,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52291,7 +52291,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -52327,7 +52327,7 @@ { "key": "response-recursively-retrieving-a-tree", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52338,7 +52338,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response recursively retrieving a tree", + "description": "

    Response recursively retrieving a tree

    ", "example": { "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", @@ -52391,13 +52391,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "Actionscript", "Android", @@ -52447,7 +52447,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "name": "NAME" @@ -52456,7 +52456,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" @@ -52506,7 +52506,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52515,7 +52515,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "limit": "collaborators_only", "origin": "organization", @@ -52595,7 +52595,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52604,7 +52604,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "limit": "collaborators_only", "origin": "organization", @@ -52650,7 +52650,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52658,7 +52658,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52706,7 +52706,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52716,7 +52716,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "limit": "collaborators_only", "origin": "repository", @@ -52805,7 +52805,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52815,7 +52815,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "limit": "collaborators_only", "origin": "repository", @@ -52870,7 +52870,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52879,7 +52879,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52912,13 +52912,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "limit": "collaborators_only", "origin": "organization", @@ -52992,13 +52992,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "limit": "collaborators_only", "origin": "user", @@ -53034,12 +53034,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53205,13 +53205,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -53621,7 +53621,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -53630,7 +53630,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -54059,7 +54059,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54069,7 +54069,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -54397,7 +54397,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -54418,7 +54418,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -54650,7 +54650,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54661,7 +54661,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -55021,7 +55021,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -55044,7 +55044,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -55297,7 +55297,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -55307,7 +55307,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -55378,7 +55378,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -55388,7 +55388,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -55523,13 +55523,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -55866,7 +55866,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -55876,7 +55876,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -55957,7 +55957,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -55967,7 +55967,7 @@ }, "response": { "statusCode": "204", - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned." + "description": "

    If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

    " } } ], @@ -56040,7 +56040,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -56057,7 +56057,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -56283,7 +56283,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -56300,7 +56300,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -56560,7 +56560,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56570,7 +56570,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -56666,7 +56666,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56677,7 +56677,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -56778,7 +56778,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -56792,7 +56792,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -56882,7 +56882,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56892,7 +56892,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56975,7 +56975,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56986,7 +56986,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -57093,7 +57093,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -57107,7 +57107,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -57220,7 +57220,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57230,7 +57230,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -57457,7 +57457,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57468,7 +57468,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", @@ -57759,7 +57759,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57770,7 +57770,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -57885,7 +57885,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57896,7 +57896,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -57990,7 +57990,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -58007,7 +58007,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -58105,7 +58105,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -58122,7 +58122,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -58205,7 +58205,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58215,7 +58215,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58283,7 +58283,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58295,7 +58295,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -58378,7 +58378,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58388,7 +58388,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -58487,7 +58487,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "bug", @@ -58502,7 +58502,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -58574,7 +58574,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58585,7 +58585,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -58682,7 +58682,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "bug :bug:", @@ -58698,7 +58698,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -58762,7 +58762,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58772,7 +58772,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58845,7 +58845,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58856,7 +58856,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -58985,7 +58985,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58995,7 +58995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", @@ -59128,7 +59128,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -59144,7 +59144,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -59244,7 +59244,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -59255,7 +59255,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -59395,7 +59395,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -59412,7 +59412,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -59504,7 +59504,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -59514,7 +59514,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59593,7 +59593,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -59603,7 +59603,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59669,13 +59669,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "mit", @@ -59767,7 +59767,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "license": "LICENSE" @@ -59776,7 +59776,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "mit", "name": "MIT License", @@ -59859,7 +59859,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -59869,7 +59869,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "LICENSE", "path": "LICENSE", @@ -59962,12 +59962,12 @@ "key": "200", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -60026,12 +60026,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -60058,13 +60058,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { @@ -60151,12 +60151,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -60183,12 +60183,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -60239,7 +60239,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60249,7 +60249,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "health_percentage": 100, "description": "My first repository on GitHub!", @@ -60340,7 +60340,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60350,7 +60350,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "description": "

    Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

    ", "example": [ [ 1302998400, @@ -60411,7 +60411,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60421,7 +60421,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "days": [ @@ -60490,7 +60490,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60500,7 +60500,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "
      \n
    • w - Start of the week, given as a Unix timestamp.
    • \n
    • a - Number of additions
    • \n
    • d - Number of deletions
    • \n
    • c - Number of commits
    • \n
    ", "example": [ { "author": { @@ -60587,7 +60587,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60597,7 +60597,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The array order is oldest week (index 0) to most recent week.", + "description": "

    The array order is oldest week (index 0) to most recent week.

    ", "example": { "all": [ 11, @@ -60757,7 +60757,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60767,7 +60767,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "description": "

    For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

    ", "example": [ [ 0, @@ -60851,7 +60851,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60861,7 +60861,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "count": 173, "uniques": 128, @@ -60992,7 +60992,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61002,7 +61002,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "path": "/github/hubot", @@ -61114,7 +61114,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61124,7 +61124,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "referrer": "Google", @@ -61211,7 +61211,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61221,7 +61221,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "count": 14850, "uniques": 3782, @@ -61383,7 +61383,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -61392,7 +61392,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 79, @@ -61669,7 +61669,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repositories": [ @@ -61684,7 +61684,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -61914,7 +61914,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -61924,7 +61924,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "description": "
      \n
    • pending, which means the migration hasn't started yet.
    • \n
    • exporting, which means the migration is in progress.
    • \n
    • exported, which means the migration finished successfully.
    • \n
    • failed, which means the migration failed.
    • \n
    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -62132,7 +62132,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -62141,7 +62141,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -62191,7 +62191,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -62200,7 +62200,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -62259,7 +62259,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -62269,7 +62269,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -62337,7 +62337,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -62347,7 +62347,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -62505,7 +62505,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62515,7 +62515,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "vcs": "subversion", "use_lfs": true, @@ -62633,7 +62633,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs": "subversion", @@ -62649,7 +62649,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "vcs": "subversion", "use_lfs": true, @@ -62769,7 +62769,7 @@ "key": "example-1", "request": { "contentType": "application/json", - "description": "Update authentication for an import", + "description": "

    Update authentication for an import

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs_username": "octocat", @@ -62783,7 +62783,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Example 1", + "description": "

    Example 1

    ", "example": { "vcs": "subversion", "use_lfs": true, @@ -62800,7 +62800,7 @@ "key": "example-2", "request": { "contentType": "application/json", - "description": "Updating the project choice", + "description": "

    Updating the project choice

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs": "tfvc", @@ -62815,7 +62815,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Example 2", + "description": "

    Example 2

    ", "example": { "vcs": "tfvc", "use_lfs": true, @@ -62839,7 +62839,7 @@ "key": "example-3", "request": { "contentType": "application/json", - "description": "Restarting an import", + "description": "

    Restarting an import

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62849,7 +62849,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "vcs": "subversion", "use_lfs": true, @@ -62911,7 +62911,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62920,7 +62920,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -62975,7 +62975,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62985,7 +62985,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2268557, @@ -63093,7 +63093,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "email": "hubot@github.com", @@ -63108,7 +63108,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2268557, "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", @@ -63171,7 +63171,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63181,7 +63181,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref_name": "refs/heads/master", @@ -63262,7 +63262,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "use_lfs": "opt_in" @@ -63275,7 +63275,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "vcs": "subversion", "use_lfs": true, @@ -63342,13 +63342,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 79, @@ -63639,13 +63639,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -63868,7 +63868,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" @@ -63877,7 +63877,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -64130,7 +64130,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" @@ -64138,7 +64138,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64200,7 +64200,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID", @@ -64209,7 +64209,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64280,7 +64280,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" @@ -64289,7 +64289,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -64457,13 +64457,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -64532,7 +64532,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -64541,7 +64541,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/applications/grants/1", @@ -64604,7 +64604,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -64612,7 +64612,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64679,13 +64679,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -64822,13 +64822,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -64972,7 +64972,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -64981,7 +64981,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -65009,7 +65009,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -65018,7 +65018,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "description": "

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

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -65162,7 +65162,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -65172,7 +65172,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -65200,7 +65200,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -65210,7 +65210,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response if returning a new token", + "description": "

    Response if returning a new token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -65276,7 +65276,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -65285,7 +65285,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -65430,7 +65430,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -65439,7 +65439,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -65501,7 +65501,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -65509,7 +65509,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -65571,13 +65571,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -65634,7 +65634,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -65643,7 +65643,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "github", "id": 1, @@ -65938,7 +65938,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "billing_email": "mona@github.com", @@ -65959,7 +65959,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -66120,7 +66120,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -66129,7 +66129,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "@timestamp": 1606929874512, @@ -66221,7 +66221,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -66230,7 +66230,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -66301,7 +66301,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66310,7 +66310,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66369,7 +66369,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -66378,7 +66378,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "installations": [ @@ -66480,13 +66480,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -66569,7 +66569,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -66578,7 +66578,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -66634,7 +66634,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -66643,7 +66643,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -66711,7 +66711,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66720,7 +66720,7 @@ }, "response": { "statusCode": "204", - "description": "If the user is blocked:" + "description": "

    If the user is blocked:

    " } } ], @@ -66770,7 +66770,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66779,7 +66779,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66829,7 +66829,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66838,7 +66838,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66852,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", @@ -66877,7 +66877,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "organization_id": "ORGANIZATION_ID" @@ -66886,7 +66886,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response - list of custom role names", + "description": "

    Response - list of custom role names

    ", "example": { "total_count": 2, "custom_roles": [ @@ -66956,7 +66956,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -66965,7 +66965,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67058,7 +67058,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -67067,7 +67067,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67189,7 +67189,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "email": "octocat@github.com", @@ -67206,7 +67206,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "login": "monalisa", @@ -67290,7 +67290,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -67299,7 +67299,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67371,7 +67371,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -67381,7 +67381,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67485,7 +67485,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -67494,7 +67494,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -67570,7 +67570,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -67579,7 +67579,7 @@ }, "response": { "statusCode": "204", - "description": "Response if requester is an organization member and user is a member" + "description": "

    Response if requester is an organization member and user is a member

    " } } ], @@ -67633,7 +67633,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -67642,7 +67642,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67692,7 +67692,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -67702,7 +67702,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -67812,7 +67812,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -67822,7 +67822,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -67916,7 +67916,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -67925,7 +67925,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67988,7 +67988,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -67997,7 +67997,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -68065,7 +68065,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -68074,7 +68074,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a public member" + "description": "

    Response if user is a public member

    " } } ], @@ -68124,7 +68124,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -68133,7 +68133,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68183,7 +68183,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -68192,7 +68192,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68251,13 +68251,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", @@ -68392,7 +68392,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -68401,7 +68401,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", @@ -68500,7 +68500,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "active" @@ -68512,7 +68512,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -68635,7 +68635,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -68644,7 +68644,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -68712,7 +68712,7 @@ { "key": "202", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -68721,13 +68721,13 @@ }, "response": { "statusCode": "202", - "description": "User is getting converted asynchronously" + "description": "

    User is getting converted asynchronously

    " } }, { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -68736,7 +68736,7 @@ }, "response": { "statusCode": "204", - "description": "User was converted" + "description": "

    User was converted

    " } } ], @@ -68794,7 +68794,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -68803,7 +68803,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68864,7 +68864,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -68873,7 +68873,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -69149,7 +69149,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -69170,7 +69170,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -69243,7 +69243,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -69253,7 +69253,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -69494,7 +69494,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -69510,7 +69510,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -69582,7 +69582,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -69591,7 +69591,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -69641,7 +69641,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -69651,7 +69651,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -69761,7 +69761,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -69771,7 +69771,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -69841,7 +69841,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -69851,7 +69851,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -69942,7 +69942,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -69953,7 +69953,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -70059,7 +70059,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -70069,7 +70069,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -70123,7 +70123,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -70132,7 +70132,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70207,7 +70207,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -70216,7 +70216,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 197, @@ -70351,7 +70351,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -70362,7 +70362,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 197, "name": "hello_docker", @@ -70456,7 +70456,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -70466,7 +70466,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70550,7 +70550,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -70560,7 +70560,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70667,7 +70667,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -70678,7 +70678,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 245301, @@ -70788,7 +70788,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -70800,7 +70800,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 836, "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", @@ -70889,7 +70889,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -70900,7 +70900,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70984,7 +70984,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -70995,7 +70995,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71066,13 +71066,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 197, @@ -71190,7 +71190,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -71200,7 +71200,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 40201, "name": "octo-name", @@ -71352,7 +71352,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -71361,7 +71361,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71436,7 +71436,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -71445,7 +71445,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71543,7 +71543,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -71553,7 +71553,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 45763, @@ -71662,7 +71662,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -71673,7 +71673,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 214, "name": "sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a", @@ -71753,7 +71753,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -71763,7 +71763,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71838,7 +71838,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -71848,7 +71848,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71928,7 +71928,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -71937,7 +71937,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 197, @@ -72072,7 +72072,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -72083,7 +72083,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 40201, "name": "octo-name", @@ -72244,7 +72244,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -72254,7 +72254,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72338,7 +72338,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -72348,7 +72348,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72423,7 +72423,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -72434,7 +72434,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3497268, @@ -72561,7 +72561,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -72573,7 +72573,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 387039, "name": "0.2.0", @@ -72659,7 +72659,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -72670,7 +72670,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72754,7 +72754,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", @@ -72765,7 +72765,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72827,7 +72827,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72837,7 +72837,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -72978,7 +72978,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "source": { @@ -72994,7 +72994,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -73141,7 +73141,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "cname": "octocatblog.com", @@ -73157,7 +73157,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73211,7 +73211,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73220,7 +73220,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73292,7 +73292,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73302,7 +73302,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", @@ -73381,7 +73381,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73391,7 +73391,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", "status": "queued" @@ -73441,7 +73441,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73451,7 +73451,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -73537,7 +73537,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73548,7 +73548,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -73625,7 +73625,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73635,7 +73635,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "domain": { "host": "example.com", @@ -73787,7 +73787,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -73796,7 +73796,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -73893,7 +73893,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Organization Roadmap", @@ -73906,7 +73906,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -73997,7 +73997,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -74006,7 +74006,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -74154,7 +74154,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -74163,7 +74163,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -74258,7 +74258,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -74266,7 +74266,7 @@ }, "response": { "statusCode": "204", - "description": "Delete Success" + "description": "

    Delete Success

    " } } ], @@ -74365,7 +74365,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74375,7 +74375,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", @@ -74497,7 +74497,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Projects Documentation", @@ -74511,7 +74511,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -74621,13 +74621,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", @@ -74747,7 +74747,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -74756,7 +74756,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/users/octocat", @@ -74836,7 +74836,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -74845,7 +74845,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -74959,7 +74959,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -74968,7 +74968,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -75057,7 +75057,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -75065,7 +75065,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75145,7 +75145,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -75153,7 +75153,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75243,7 +75243,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -75252,7 +75252,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/cards/1478", @@ -75376,7 +75376,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -75385,7 +75385,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -75509,7 +75509,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -75518,7 +75518,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -75626,7 +75626,7 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -75635,7 +75635,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75701,7 +75701,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -75710,7 +75710,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75776,7 +75776,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -75786,7 +75786,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "permission": "admin", "user": { @@ -75868,7 +75868,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -75877,7 +75877,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -75954,7 +75954,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -75963,7 +75963,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -76022,7 +76022,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -76030,7 +76030,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -76094,7 +76094,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -76102,7 +76102,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -76173,7 +76173,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -76182,7 +76182,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/367", @@ -76257,7 +76257,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -76266,7 +76266,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -76421,7 +76421,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76431,7 +76431,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -77072,7 +77072,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Amazing new feature", @@ -77088,7 +77088,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -77684,7 +77684,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77695,7 +77695,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "

    Pass the appropriate media type to fetch diff and patch formats.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -78346,7 +78346,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "new title", @@ -78363,7 +78363,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -78977,7 +78977,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78988,7 +78988,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -79141,7 +79141,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -79152,7 +79152,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", @@ -79229,7 +79229,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -79239,7 +79239,7 @@ }, "response": { "statusCode": "204", - "description": "Response if pull request has been merged" + "description": "

    Response if pull request has been merged

    " } } ], @@ -79341,7 +79341,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -79352,7 +79352,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if merge was successful", + "description": "

    if merge was successful

    ", "example": { "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "merged": true, @@ -79443,7 +79443,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" @@ -79457,7 +79457,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Updating pull request branch.", "url": "https://github.com/repos/octocat/Hello-World/pulls/53" @@ -79573,7 +79573,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -79583,7 +79583,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -79696,7 +79696,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -79707,7 +79707,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -79833,7 +79833,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "I like this too!" @@ -79847,7 +79847,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -79958,7 +79958,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -79968,7 +79968,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80082,7 +80082,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80093,7 +80093,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -80230,11 +80230,15 @@ }, { "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "description": "

    This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + }, "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, { @@ -80301,7 +80305,7 @@ "key": "example-for-a-multi-line-comment", "request": { "contentType": "application/json", - "description": "Example for a multi-line comment", + "description": "

    Example for a multi-line comment

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!", @@ -80321,7 +80325,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -80382,7 +80386,7 @@ } ], "previews": [], - "descriptionHTML": "

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    \n

    You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required.

    \n

    Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    \n

    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.

    ", + "descriptionHTML": "

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    \n

    The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

    \n

    Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    \n

    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.

    ", "statusCodes": [ { "httpStatusCode": "201", @@ -80460,7 +80464,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!" @@ -80475,7 +80479,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -80610,7 +80614,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80621,7 +80625,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "users": [ { @@ -80742,7 +80746,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -80763,7 +80767,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -81410,7 +81414,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -81430,7 +81434,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81509,7 +81513,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -81520,7 +81524,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The list of reviews returns in chronological order.", + "description": "

    The list of reviews returns in chronological order.

    ", "example": [ { "id": 80, @@ -81818,7 +81822,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", @@ -81841,7 +81845,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -81952,7 +81956,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -81964,7 +81968,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -82082,7 +82086,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is close to perfect! Please address the suggested inline change. And add more about this." @@ -82097,7 +82101,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -82204,7 +82208,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -82216,7 +82220,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -82345,7 +82349,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -82357,7 +82361,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -82499,7 +82503,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -82511,7 +82515,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -82647,7 +82651,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -82659,7 +82663,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -82740,13 +82744,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "resources": { "core": { @@ -82899,7 +82903,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -82911,7 +82915,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -83024,7 +83028,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -83039,7 +83043,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "

    Response when the reaction type has already been added to this team discussion comment

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -83072,7 +83076,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -83087,7 +83091,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -83190,7 +83194,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -83202,7 +83206,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83294,7 +83298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -83305,7 +83309,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -83409,7 +83413,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -83423,7 +83427,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -83456,7 +83460,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -83470,7 +83474,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -83564,7 +83568,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -83575,7 +83579,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83667,7 +83671,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -83678,7 +83682,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -83786,7 +83790,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -83800,7 +83804,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -83833,7 +83837,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -83847,7 +83851,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -83945,7 +83949,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -83956,7 +83960,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84048,7 +84052,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84059,7 +84063,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -84167,7 +84171,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -84181,7 +84185,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -84214,7 +84218,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -84228,7 +84232,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -84326,7 +84330,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84337,7 +84341,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84429,7 +84433,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84440,7 +84444,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -84552,7 +84556,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -84566,7 +84570,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -84599,7 +84603,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -84613,7 +84617,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -84711,7 +84715,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84722,7 +84726,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84814,7 +84818,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84825,7 +84829,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -84933,7 +84937,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -84947,7 +84951,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -84980,7 +84984,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -84994,7 +84998,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -85092,7 +85096,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85103,7 +85107,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85193,7 +85197,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85204,7 +85208,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -85310,7 +85314,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -85324,7 +85328,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -85357,7 +85361,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -85371,7 +85375,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -85469,7 +85473,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85480,7 +85484,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85572,7 +85576,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -85583,7 +85587,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -85687,7 +85691,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -85701,7 +85705,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -85810,7 +85814,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -85820,7 +85824,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -85915,7 +85919,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -85928,7 +85932,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -85978,6 +85982,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86022,7 +86027,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -86032,7 +86037,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", @@ -86123,8 +86128,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86132,6 +86136,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86235,7 +86240,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -86254,7 +86259,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -86348,8 +86353,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86357,6 +86361,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", "title": "Generate release notes content for a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86421,7 +86426,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -86437,7 +86442,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Name and body of generated release notes", + "description": "

    Name and body of generated release notes

    ", "example": { "name": "Release v1.0.0 is now available!", "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa" @@ -86456,8 +86461,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86465,6 +86469,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86491,7 +86496,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -86501,7 +86506,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -86587,8 +86592,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86596,6 +86600,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86632,7 +86637,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -86643,7 +86648,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -86733,8 +86738,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86742,6 +86746,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86777,7 +86782,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -86788,7 +86793,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", + "description": "

    Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -86878,8 +86883,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86887,6 +86891,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86987,7 +86992,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -87006,7 +87011,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -87096,8 +87101,7 @@ "httpStatusCode": "404", "description": "

    Not Found if the discussion category name is invalid

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -87105,6 +87109,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -87140,7 +87145,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -87150,7 +87155,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87161,8 +87166,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ @@ -87208,7 +87212,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -87219,7 +87223,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "

    To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -87347,7 +87351,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "foo-1.0.0-osx.zip", @@ -87362,7 +87366,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -87451,7 +87455,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -87461,7 +87465,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87534,7 +87538,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -87545,7 +87549,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", @@ -87654,7 +87658,7 @@ "key": "default", "request": { "contentType": "*/*", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -87665,7 +87669,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for successful upload", + "description": "

    Response for successful upload

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -87808,7 +87812,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -87817,7 +87821,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -88140,7 +88144,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -88158,7 +88162,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -88336,7 +88340,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -88346,7 +88350,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -89375,7 +89379,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -89394,7 +89398,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -89965,7 +89969,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -89974,7 +89978,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -90032,7 +90036,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90041,7 +90045,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -90087,7 +90091,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90096,7 +90100,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -90151,7 +90155,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90161,7 +90165,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "errors": [ { @@ -90260,7 +90264,7 @@ { "key": "response-if-repository-contains-content", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90270,7 +90274,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if repository contains content", + "description": "

    if repository contains content

    ", "example": [ { "login": "octocat", @@ -90375,7 +90379,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "event_type": "on-demand-test", @@ -90391,7 +90395,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -90441,7 +90445,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90451,7 +90455,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "C": 78769, "Python": 7769 @@ -90519,7 +90523,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90529,7 +90533,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "v0.1", @@ -90605,7 +90609,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90615,7 +90619,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -90695,7 +90699,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90705,7 +90709,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -90777,7 +90781,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "names": [ @@ -90795,7 +90799,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -90880,7 +90884,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_owner": "github", @@ -90897,7 +90901,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -91169,7 +91173,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -91178,7 +91182,7 @@ }, "response": { "statusCode": "204", - "description": "Response if repository is enabled with vulnerability alerts" + "description": "

    Response if repository is enabled with vulnerability alerts

    " } } ], @@ -91228,7 +91232,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -91237,7 +91241,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -91283,7 +91287,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -91292,7 +91296,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -91387,7 +91391,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "owner": "octocat", @@ -91404,7 +91408,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -91557,13 +91561,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -91779,13 +91783,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -92168,13 +92172,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -92421,7 +92425,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -92430,7 +92434,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -92594,7 +92598,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -92604,7 +92608,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -92677,7 +92681,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", @@ -92691,7 +92695,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "response", + "description": "

    response

    ", "example": { "id": 1, "key_prefix": "TICKET-", @@ -92755,7 +92759,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -92766,7 +92770,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key_prefix": "TICKET-", @@ -92830,7 +92834,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -92840,7 +92844,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -92911,7 +92915,7 @@ { "key": "response-if-content-is-a-file", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -92922,7 +92926,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a file", + "description": "

    Response if content is a file

    ", "example": { "type": "file", "encoding": "base64", @@ -92946,7 +92950,7 @@ { "key": "response-if-content-is-a-directory", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -92957,7 +92961,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a directory", + "description": "

    Response if content is a directory

    ", "example": [ { "type": "file", @@ -92997,7 +93001,7 @@ { "key": "response-if-content-is-a-symlink", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -93008,7 +93012,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a symlink", + "description": "

    Response if content is a symlink

    ", "example": { "type": "symlink", "target": "/path/to/symlink/target", @@ -93031,7 +93035,7 @@ { "key": "response-if-content-is-a-submodule", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -93042,7 +93046,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a submodule", + "description": "

    Response if content is a submodule

    ", "example": { "type": "submodule", "submodule_git_url": "git://github.com/jquery/qunit.git", @@ -93327,7 +93331,7 @@ "key": "example-for-creating-a-file", "request": { "contentType": "application/json", - "description": "Example for creating a file", + "description": "

    Example for creating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -93346,7 +93350,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -93405,7 +93409,7 @@ "key": "example-for-updating-a-file", "request": { "contentType": "application/json", - "description": "Example for updating a file", + "description": "

    Example for updating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "a new commit message", @@ -93425,7 +93429,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -93688,7 +93692,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -93707,7 +93711,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": null, "commit": { @@ -93815,7 +93819,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -93825,7 +93829,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -93916,7 +93920,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -93927,7 +93931,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -94008,7 +94012,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -94018,7 +94022,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -94073,7 +94077,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -94083,7 +94087,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -94165,7 +94169,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -94175,7 +94179,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -94352,7 +94356,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -94362,7 +94366,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -94935,7 +94939,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -94944,7 +94948,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -94994,7 +94998,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -95003,7 +95007,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -95051,7 +95055,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -95061,7 +95065,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -95132,7 +95136,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "pattern": "v1.*" @@ -95145,7 +95149,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled": true } @@ -95211,7 +95215,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -95221,7 +95225,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -95296,7 +95300,7 @@ { "key": "response-with-filter", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -95305,7 +95309,7 @@ "response": { "statusCode": "200", "contentType": "application/scim+json", - "description": "Response with filter", + "description": "

    Response with filter

    ", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" @@ -95348,7 +95352,7 @@ { "key": "response-without-filter", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -95357,7 +95361,7 @@ "response": { "statusCode": "200", "contentType": "application/scim+json", - "description": "Response without filter", + "description": "

    Response without filter

    ", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" @@ -95700,7 +95704,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -95709,7 +95713,7 @@ "response": { "statusCode": "201", "contentType": "application/scim+json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" @@ -95809,7 +95813,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -95819,7 +95823,7 @@ "response": { "statusCode": "200", "contentType": "application/scim+json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" @@ -96129,7 +96133,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -96139,7 +96143,7 @@ "response": { "statusCode": "200", "contentType": "application/scim+json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" @@ -96438,7 +96442,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -96448,7 +96452,7 @@ "response": { "statusCode": "200", "contentType": "application/scim+json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" @@ -96544,7 +96548,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -96553,7 +96557,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -96650,13 +96654,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 7, "incomplete_results": false, @@ -96836,13 +96840,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "incomplete_results": false, @@ -97065,13 +97069,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 280, "incomplete_results": false, @@ -97278,13 +97282,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "incomplete_results": false, @@ -97410,13 +97414,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 40, "incomplete_results": false, @@ -97593,13 +97597,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 6, "incomplete_results": false, @@ -97770,13 +97774,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 12, "incomplete_results": false, @@ -97914,7 +97918,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -97923,7 +97927,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -98516,7 +98520,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -98525,7 +98529,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -99127,7 +99131,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -99137,7 +99141,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -99251,7 +99255,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -99262,7 +99266,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -99379,7 +99383,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "resolved", @@ -99394,7 +99398,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -99514,7 +99518,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -99525,7 +99529,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "commit", @@ -99636,7 +99640,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -99645,7 +99649,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -99782,7 +99786,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Justice League", @@ -99797,7 +99801,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -99899,7 +99903,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -99909,7 +99913,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -100067,7 +100071,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -100082,7 +100086,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -100176,7 +100180,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -100185,7 +100189,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -100249,7 +100253,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -100259,7 +100263,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -100357,7 +100361,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -100368,7 +100372,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -100484,7 +100488,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -100494,7 +100498,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -100553,7 +100557,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -100563,7 +100567,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -100627,7 +100631,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -100637,7 +100641,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -100807,7 +100811,7 @@ { "key": "alternative-response-with-repository-permissions", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -100819,7 +100823,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with repository permissions", + "description": "

    Alternative response with repository permissions

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -101159,7 +101163,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -101170,7 +101174,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -101234,7 +101238,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -101245,7 +101249,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -101309,7 +101313,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -101319,7 +101323,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -101384,7 +101388,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -101393,7 +101397,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -101542,7 +101546,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -101556,7 +101560,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the updated information already exists", + "description": "

    Response when the updated information already exists

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -101611,7 +101615,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -101625,7 +101629,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -101726,7 +101730,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -101734,7 +101738,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -101797,7 +101801,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -101806,7 +101810,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -101899,7 +101903,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -101909,7 +101913,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -102016,7 +102020,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -102025,7 +102029,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -102083,7 +102087,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -102092,7 +102096,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -102155,7 +102159,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -102164,7 +102168,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -102329,7 +102333,7 @@ { "key": "alternative-response-with-extra-repository-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -102340,7 +102344,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with extra repository information", + "description": "

    Alternative response with extra repository information

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -102668,7 +102672,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -102678,7 +102682,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -102741,7 +102745,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -102751,7 +102755,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -102806,7 +102810,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -102815,7 +102819,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -102901,13 +102905,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -103059,7 +103063,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -103070,7 +103074,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -103183,7 +103187,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -103197,7 +103201,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -103306,7 +103310,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -103318,7 +103322,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -103438,7 +103442,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -103453,7 +103457,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -103562,7 +103566,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -103573,7 +103577,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -103651,7 +103655,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -103661,7 +103665,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -103765,7 +103769,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -103778,7 +103782,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -103878,7 +103882,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -103889,7 +103893,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -104000,7 +104004,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -104014,7 +104018,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -104114,7 +104118,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -104124,7 +104128,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -104213,7 +104217,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -104223,7 +104227,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -104351,7 +104355,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -104365,7 +104369,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -104470,7 +104474,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -104481,7 +104485,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -104606,7 +104610,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -104620,7 +104624,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -104725,7 +104729,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -104735,7 +104739,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -104804,7 +104808,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -104813,7 +104817,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -104932,7 +104936,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -104945,7 +104949,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -105041,7 +105045,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -105051,7 +105055,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -105167,7 +105171,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -105180,7 +105184,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -105276,7 +105280,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -105285,7 +105289,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -105333,7 +105337,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -105343,7 +105347,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "group_id": "123", "group_name": "Octocat admins", @@ -105434,7 +105438,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -105443,7 +105447,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "groups": [ { @@ -105503,7 +105507,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -105513,7 +105517,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "groups": [ { @@ -105587,7 +105591,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "group_id": 123 @@ -105600,7 +105604,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "group_id": "123", "group_name": "Octocat admins", @@ -105675,7 +105679,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -105684,7 +105688,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -105750,7 +105754,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -105760,7 +105764,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -105873,7 +105877,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -105883,7 +105887,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -105960,7 +105964,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -105971,7 +105975,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -106051,7 +106055,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -106062,7 +106066,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -106130,7 +106134,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -106140,7 +106144,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -106199,7 +106203,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -106208,7 +106212,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -106312,7 +106316,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -106321,7 +106325,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -106393,7 +106397,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -106402,7 +106406,7 @@ }, "response": { "statusCode": "204", - "description": "if user is a member" + "description": "

    if user is a member

    " } } ], @@ -106452,7 +106456,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -106461,7 +106465,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -106519,7 +106523,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -106528,7 +106532,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -106578,7 +106582,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -106588,7 +106592,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -106659,7 +106663,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -106669,7 +106673,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -106732,7 +106736,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -106741,7 +106745,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -106801,7 +106805,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -106810,7 +106814,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "groups": [ { @@ -106870,7 +106874,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -106880,7 +106884,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "groups": [ { @@ -107023,7 +107027,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "groups": [ @@ -107042,7 +107046,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "groups": [ { @@ -107093,7 +107097,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -107102,7 +107106,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "groups": [ { @@ -107321,7 +107325,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "groups": [ @@ -107340,7 +107344,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "groups": [ { @@ -107387,13 +107391,13 @@ { "key": "response-with-public-and-private-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public and private profile information", + "description": "

    Response with public and private profile information

    ", "example": { "login": "octocat", "id": 1, @@ -107445,13 +107449,13 @@ { "key": "response-with-public-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public profile information", + "description": "

    Response with public profile information

    ", "example": { "login": "octocat", "id": 1, @@ -107619,13 +107623,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -107737,13 +107741,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -107806,7 +107810,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -107815,7 +107819,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "octocat", "id": 1, @@ -107855,7 +107859,7 @@ { "key": "response-with-git-hub-plan-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -107864,7 +107868,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with GitHub plan information", + "description": "

    Response with GitHub plan information

    ", "example": { "login": "octocat", "id": 1, @@ -107969,7 +107973,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -107978,7 +107982,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "contexts": [ { @@ -108024,13 +108028,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -108105,7 +108109,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -108113,7 +108117,7 @@ }, "response": { "statusCode": "204", - "description": "If the user is blocked:" + "description": "

    If the user is blocked:

    " } } ], @@ -108166,7 +108170,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -108174,7 +108178,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -108231,7 +108235,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -108239,7 +108243,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -108299,13 +108303,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -108379,13 +108383,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -108455,13 +108459,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@octocat.org", @@ -108546,12 +108550,12 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -108617,13 +108621,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -108695,13 +108699,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -108781,13 +108785,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -108858,7 +108862,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -108866,7 +108870,7 @@ }, "response": { "statusCode": "204", - "description": "if the person is followed by the authenticated user" + "description": "

    if the person is followed by the authenticated user

    " } } ], @@ -108919,7 +108923,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -108927,7 +108931,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -108980,7 +108984,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -108988,7 +108992,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -109059,7 +109063,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -109068,7 +109072,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -109145,7 +109149,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -109154,7 +109158,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -109222,7 +109226,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -109231,7 +109235,7 @@ }, "response": { "statusCode": "204", - "description": "if the user follows the target user" + "description": "

    if the user follows the target user

    " } } ], @@ -109283,13 +109287,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -109380,13 +109384,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -109478,7 +109482,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -109487,7 +109491,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -109575,7 +109579,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -109583,7 +109587,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -109658,7 +109662,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -109667,7 +109671,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -109752,13 +109756,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -109845,13 +109849,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -109917,7 +109921,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -109926,7 +109930,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -109988,7 +109992,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -109996,7 +110000,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -110067,7 +110071,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -110076,7 +110080,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -110141,7 +110145,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -110152,7 +110156,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -110271,7 +110275,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -110282,7 +110286,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -110363,7 +110367,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -110374,7 +110378,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -110474,7 +110478,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -110486,7 +110490,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -110601,7 +110605,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -110612,7 +110616,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -110686,7 +110690,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -110696,7 +110700,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Repository", @@ -110985,7 +110989,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -111008,7 +111012,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -111101,7 +111105,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -111112,7 +111116,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -111426,7 +111430,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -111443,7 +111447,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -111532,7 +111536,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -111542,7 +111546,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -111601,7 +111605,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -111611,7 +111615,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -111670,7 +111674,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -111680,7 +111684,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index a37a323530..2c8f086fc7 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -52,7 +52,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62,7 +62,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -146,7 +146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -157,7 +157,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 11, "node_id": "MDg6QXJ0aWZhY3QxMQ==", @@ -224,7 +224,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -234,7 +234,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -298,7 +298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -309,7 +309,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -382,7 +382,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -393,7 +393,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -461,7 +461,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -470,7 +470,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_organizations": "all", "allowed_actions": "selected", @@ -542,7 +542,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_organizations": "all", @@ -554,7 +554,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -609,7 +609,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -618,7 +618,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -689,7 +689,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -703,7 +703,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -749,7 +749,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -758,7 +758,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -804,7 +804,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -813,7 +813,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -850,7 +850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -859,7 +859,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -927,7 +927,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -943,7 +943,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -980,7 +980,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -989,7 +989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_repositories": "all", "allowed_actions": "selected", @@ -1061,7 +1061,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_repositories": "all", @@ -1073,7 +1073,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1128,7 +1128,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1137,7 +1137,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -1316,7 +1316,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -1330,7 +1330,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1376,7 +1376,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1385,7 +1385,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1431,7 +1431,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1440,7 +1440,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1477,7 +1477,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1486,7 +1486,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1554,7 +1554,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1570,7 +1570,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1616,7 +1616,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1626,7 +1626,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled": true, "allowed_actions": "selected", @@ -1702,7 +1702,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled": true, @@ -1715,7 +1715,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1761,7 +1761,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1771,7 +1771,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1848,7 +1848,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1865,7 +1865,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1922,7 +1922,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1931,7 +1931,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "secrets": [ @@ -1992,7 +1992,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -2001,7 +2001,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2051,7 +2051,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2061,7 +2061,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2161,7 +2161,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2179,14 +2179,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2204,7 +2204,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -2254,7 +2254,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2263,7 +2263,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2327,7 +2327,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2337,7 +2337,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -2471,7 +2471,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -2485,7 +2485,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2540,7 +2540,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2550,7 +2550,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -2609,7 +2609,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2619,7 +2619,7 @@ }, "response": { "statusCode": "204", - "description": "Response when repository was removed from the selected list" + "description": "

    Response when repository was removed from the selected list

    " } } ], @@ -2687,7 +2687,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2697,7 +2697,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -2758,7 +2758,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2768,7 +2768,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2827,7 +2827,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2838,7 +2838,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2919,7 +2919,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2933,14 +2933,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2954,7 +2954,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3013,7 +3013,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3023,7 +3023,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3080,7 +3080,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -3089,7 +3089,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -3216,7 +3216,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3237,7 +3237,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3292,7 +3292,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3302,7 +3302,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3392,7 +3392,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3406,7 +3406,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "Expensive hardware runners", @@ -3461,7 +3461,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3470,7 +3470,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3534,7 +3534,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3544,7 +3544,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -3624,7 +3624,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -3639,7 +3639,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3694,7 +3694,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3704,7 +3704,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3759,7 +3759,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3769,7 +3769,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3833,7 +3833,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3843,7 +3843,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -3962,7 +3962,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -3977,7 +3977,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4032,7 +4032,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4042,7 +4042,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4097,7 +4097,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4107,7 +4107,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4162,7 +4162,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -4171,7 +4171,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -4303,7 +4303,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4324,7 +4324,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4380,7 +4380,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4390,7 +4390,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4481,7 +4481,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4495,7 +4495,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4551,7 +4551,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4560,7 +4560,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4624,7 +4624,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4634,7 +4634,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -4940,7 +4940,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -4955,7 +4955,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5010,7 +5010,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5020,7 +5020,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5075,7 +5075,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5085,7 +5085,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5149,7 +5149,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5159,7 +5159,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5278,7 +5278,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -5293,7 +5293,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5348,7 +5348,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5358,7 +5358,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5413,7 +5413,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5423,7 +5423,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5480,7 +5480,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5489,7 +5489,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5584,7 +5584,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5593,7 +5593,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -5662,7 +5662,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5671,7 +5671,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -5712,7 +5712,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5721,7 +5721,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -5771,7 +5771,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -5781,7 +5781,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -5856,7 +5856,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -5865,7 +5865,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5920,7 +5920,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -5929,7 +5929,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6024,7 +6024,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6033,7 +6033,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -6102,7 +6102,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6111,7 +6111,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -6152,7 +6152,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6161,7 +6161,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -6211,7 +6211,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6221,7 +6221,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -6296,7 +6296,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6305,7 +6305,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6369,7 +6369,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6379,7 +6379,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6483,7 +6483,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6493,7 +6493,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -6571,7 +6571,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6581,7 +6581,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -6631,7 +6631,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6641,7 +6641,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -6700,7 +6700,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6711,7 +6711,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -6795,7 +6795,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6805,7 +6805,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6862,7 +6862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6873,7 +6873,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 399444496, "run_id": 29679449, @@ -7025,7 +7025,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7035,7 +7035,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7122,7 +7122,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7133,7 +7133,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "jobs": [ @@ -7381,7 +7381,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7391,7 +7391,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -7637,7 +7637,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7648,7 +7648,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 30433642, "name": "Build", @@ -7878,7 +7878,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7888,7 +7888,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7943,7 +7943,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7953,7 +7953,7 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8012,7 +8012,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8022,7 +8022,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8077,7 +8077,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8087,7 +8087,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8150,7 +8150,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8160,7 +8160,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8311,7 +8311,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8322,7 +8322,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -8569,7 +8569,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8579,7 +8579,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "workflows": [ @@ -8670,7 +8670,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8681,7 +8681,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", @@ -8755,7 +8755,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8765,7 +8765,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8851,7 +8851,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -8868,7 +8868,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8930,7 +8930,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8940,7 +8940,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8990,12 +8990,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9071,7 +9071,7 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9080,7 +9080,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9151,7 +9151,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -9159,7 +9159,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9223,7 +9223,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9232,7 +9232,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9287,7 +9287,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -9295,7 +9295,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9359,7 +9359,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -9368,7 +9368,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9423,7 +9423,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -9431,7 +9431,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9486,7 +9486,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -9494,7 +9494,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9549,7 +9549,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -9557,7 +9557,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9586,13 +9586,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", @@ -9724,13 +9724,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -9880,24 +9880,24 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -9950,7 +9950,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -9959,7 +9959,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": "1", "repository": { @@ -10092,7 +10092,7 @@ { "key": "205", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10100,7 +10100,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -10145,7 +10145,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10154,7 +10154,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -10223,7 +10223,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10232,7 +10232,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -10289,7 +10289,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10297,7 +10297,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10413,7 +10413,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10423,7 +10423,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -10567,7 +10567,7 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10576,14 +10576,14 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10592,7 +10592,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -10662,7 +10662,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10672,7 +10672,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "login": "octocat", @@ -10700,7 +10700,7 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10710,7 +10710,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -10813,13 +10813,13 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -10949,13 +10949,13 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/vnd.github.v3.star+json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -11140,7 +11140,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11149,7 +11149,7 @@ }, "response": { "statusCode": "204", - "description": "Response if this repository is starred by you" + "description": "

    Response if this repository is starred by you

    " } } ], @@ -11211,7 +11211,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11220,7 +11220,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11282,7 +11282,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11291,7 +11291,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11390,7 +11390,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -11399,7 +11399,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -11589,7 +11589,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11599,7 +11599,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -11667,7 +11667,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11677,7 +11677,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if you subscribe to the repository", + "description": "

    if you subscribe to the repository

    ", "example": { "subscribed": true, "ignored": false, @@ -11759,7 +11759,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11769,7 +11769,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -11823,7 +11823,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11832,7 +11832,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11878,13 +11878,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -12057,7 +12057,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -12066,7 +12066,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -12202,13 +12202,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -12286,7 +12286,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "code": "CODE" @@ -12295,7 +12295,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -12413,13 +12413,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "The permissions the installation has are included under the `permissions` key.", + "description": "

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

    ", "example": [ { "id": 1, @@ -12513,7 +12513,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -12522,7 +12522,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -12618,7 +12618,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -12626,7 +12626,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13536,7 +13536,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "respoitory": "Hello-World", @@ -13552,7 +13552,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", @@ -13743,7 +13743,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -13751,7 +13751,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13797,7 +13797,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -13805,7 +13805,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13846,7 +13846,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "app_slug": "APP_SLUG" @@ -13855,7 +13855,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -13941,7 +13941,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -13950,7 +13950,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -14046,7 +14046,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14056,7 +14056,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -14151,7 +14151,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -14160,7 +14160,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -14259,13 +14259,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -14428,12 +14428,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14516,7 +14516,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14527,7 +14527,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 101, "title": "[A-1234] Error found in core/models.py file'", @@ -14604,13 +14604,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "You can find the permissions for the installation under the `permissions` key.", + "description": "

    You can find the permissions for the installation under the permissions key.

    ", "example": { "total_count": 2, "installations": [ @@ -14787,7 +14787,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -14796,7 +14796,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "description": "

    The access the user has to each repository is included in the hash under the permissions key.

    ", "example": { "total_count": 1, "repositories": [ @@ -14988,7 +14988,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -14997,7 +14997,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15060,7 +15060,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -15069,7 +15069,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15136,7 +15136,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -15147,7 +15147,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15202,7 +15202,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -15211,7 +15211,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15264,7 +15264,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -15276,7 +15276,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -15379,7 +15379,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -15391,7 +15391,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -15490,7 +15490,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -15501,7 +15501,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16447,7 +16447,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", @@ -16465,7 +16465,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -16603,7 +16603,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -16613,7 +16613,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -16710,7 +16710,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -16720,7 +16720,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -16813,7 +16813,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -16822,7 +16822,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16851,13 +16851,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -16948,7 +16948,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content_type": "json", @@ -16960,7 +16960,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -16989,6 +16989,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -17042,7 +17043,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17052,7 +17053,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "master", @@ -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", @@ -17132,7 +17133,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17142,7 +17143,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -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", @@ -17217,7 +17218,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "my_renamed_branch" @@ -17231,7 +17232,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "master", "commit": { @@ -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", @@ -17418,7 +17419,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base": "master", @@ -17433,7 +17434,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Successful Response (The resulting merge commit)", + "description": "

    Successful Response (The resulting merge commit)

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -17559,8 +17560,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -17607,7 +17607,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17618,7 +17618,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", "required_status_checks": { @@ -18467,7 +18467,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "required_status_checks": { @@ -18523,7 +18523,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -18593,7 +18593,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18603,7 +18603,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -18663,7 +18663,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18674,7 +18674,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -18734,7 +18734,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18745,7 +18745,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -18805,7 +18805,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18815,7 +18815,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -18875,7 +18875,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18886,7 +18886,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -19089,7 +19089,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "dismissal_restrictions": { @@ -19121,7 +19121,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -19232,7 +19232,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19242,7 +19242,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19302,7 +19302,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19313,7 +19313,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -19379,7 +19379,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19390,7 +19390,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -19456,7 +19456,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19466,7 +19466,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19528,7 +19528,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19539,7 +19539,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -19631,7 +19631,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "strict": true, @@ -19648,7 +19648,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -19720,7 +19720,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19730,7 +19730,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19786,7 +19786,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19797,7 +19797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -19874,7 +19874,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19885,7 +19885,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci", "continuous-integration/jenkins" @@ -19971,7 +19971,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19982,7 +19982,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -20063,7 +20063,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20074,7 +20074,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -20141,7 +20141,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20152,7 +20152,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", @@ -20293,7 +20293,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20303,7 +20303,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20359,7 +20359,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20370,7 +20370,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -20487,7 +20487,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20498,7 +20498,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -20615,7 +20615,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20626,7 +20626,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -20743,7 +20743,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20754,7 +20754,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -20857,7 +20857,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20868,7 +20868,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -20958,7 +20958,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20969,7 +20969,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21059,7 +21059,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21070,7 +21070,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21160,7 +21160,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21171,7 +21171,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21247,7 +21247,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21258,7 +21258,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -21354,7 +21354,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21365,7 +21365,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -21461,7 +21461,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21472,7 +21472,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -21568,7 +21568,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21579,7 +21579,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -22607,7 +22607,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Example of an in_progress conclusion", + "description": "

    Example of an in_progress conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -22629,7 +22629,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "

    Response for in_progress conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -22726,7 +22726,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Example of a completed conclusion", + "description": "

    Example of a completed conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -22782,7 +22782,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "

    Response for completed conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -22927,7 +22927,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22938,7 +22938,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -24024,7 +24024,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -24073,7 +24073,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -24236,7 +24236,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24247,7 +24247,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "path": "README.md", @@ -24371,7 +24371,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24382,7 +24382,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -24597,7 +24597,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24608,7 +24608,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -24762,7 +24762,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -24775,7 +24775,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the suite already exists", + "description": "

    Response when the suite already exists

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -25079,7 +25079,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -25092,7 +25092,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the suite was created", + "description": "

    Response when the suite was created

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -25505,7 +25505,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "auto_trigger_checks": [ @@ -25523,7 +25523,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "preferences": { "auto_trigger_checks": [ @@ -25814,7 +25814,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25825,7 +25825,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -26177,7 +26177,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26187,7 +26187,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -26280,7 +26280,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26291,7 +26291,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_suites": [ @@ -26590,7 +26590,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26600,7 +26600,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 4, @@ -26772,7 +26772,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26783,7 +26783,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-06-19T11:21:34Z", @@ -26952,7 +26952,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", @@ -26968,7 +26968,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-08-25T21:28:36Z", @@ -27132,7 +27132,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27143,7 +27143,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -27308,7 +27308,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27318,7 +27318,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -27429,7 +27429,7 @@ { "key": "response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27440,7 +27440,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "ref": "refs/heads/main", "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", @@ -27540,7 +27540,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27551,7 +27551,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" @@ -27681,7 +27681,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27691,7 +27691,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -27770,7 +27770,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27781,7 +27781,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "processing_status": "complete", "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -27828,13 +27828,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "citizen_code_of_conduct", @@ -27889,7 +27889,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key": "KEY" @@ -27898,7 +27898,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "contributor_covenant", "name": "Contributor Covenant", @@ -27937,6 +27937,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -27996,7 +27997,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28006,7 +28007,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -28048,8 +28049,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28057,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", @@ -28092,7 +28093,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28102,7 +28103,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a collaborator" + "description": "

    Response if user is a collaborator

    " } } ], @@ -28117,8 +28118,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28126,6 +28126,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -28191,7 +28192,7 @@ "key": "response-when-a-new-invitation-is-created", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28202,7 +28203,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when a new invitation is created", + "description": "

    Response when a new invitation is created

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -28342,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", @@ -28351,6 +28351,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -28386,7 +28387,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28396,7 +28397,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -28407,8 +28408,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28416,6 +28416,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -28451,7 +28452,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28462,7 +28463,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if user has admin permissions", + "description": "

    if user has admin permissions

    ", "example": { "permission": "admin", "user": { @@ -28500,8 +28501,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -28556,7 +28556,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28566,7 +28566,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -28758,7 +28758,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28769,7 +28769,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -28942,7 +28942,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28952,7 +28952,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -28998,13 +28998,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -29176,7 +29176,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -29184,7 +29184,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -29237,7 +29237,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -29245,7 +29245,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -29284,6 +29284,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -29375,7 +29376,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29385,7 +29386,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -29492,8 +29493,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29501,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", @@ -29537,7 +29538,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29548,7 +29549,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "branch_5", @@ -29575,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", @@ -29584,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", @@ -29638,7 +29639,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29649,7 +29650,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -30180,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", @@ -30189,6 +30189,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30243,7 +30244,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30254,7 +30255,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -30372,8 +30373,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30381,6 +30381,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30416,7 +30417,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30427,7 +30428,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", @@ -30707,8 +30708,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -30763,7 +30763,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30773,7 +30773,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -30866,7 +30866,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30877,7 +30877,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -30983,7 +30983,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Nice change" @@ -30997,7 +30997,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -31090,7 +31090,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31100,7 +31100,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -31178,7 +31178,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31189,7 +31189,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -31321,7 +31321,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff", @@ -31338,7 +31338,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -31456,7 +31456,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31467,7 +31467,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "state": "success", "statuses": [ @@ -31647,7 +31647,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31658,7 +31658,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -31797,7 +31797,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "success", @@ -31814,7 +31814,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", @@ -31861,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", @@ -31914,7 +31913,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31924,7 +31923,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -31946,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", @@ -32010,7 +32009,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "octocat@octomac", @@ -32025,7 +32024,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -32049,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", @@ -32093,7 +32092,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32104,7 +32103,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -32128,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", @@ -32172,7 +32171,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32182,7 +32181,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32193,7 +32192,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -32205,6 +32205,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -32292,7 +32293,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32302,7 +32303,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -32355,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", @@ -32364,6 +32364,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -32493,7 +32494,7 @@ "key": "simple-example", "request": { "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -32508,7 +32509,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -32571,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", @@ -32580,6 +32580,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -32615,7 +32616,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32626,7 +32627,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -32682,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", @@ -32691,6 +32691,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -32726,7 +32727,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32736,7 +32737,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32755,8 +32756,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "statuses": [ @@ -32820,7 +32820,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32831,7 +32831,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", @@ -33013,7 +33013,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "environment": "production", @@ -33030,7 +33030,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -33136,7 +33136,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33148,7 +33148,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -33220,12 +33220,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33261,13 +33261,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "repos": { "total_repos": 212, @@ -33350,12 +33350,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33382,12 +33382,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33414,12 +33414,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33446,12 +33446,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33478,12 +33478,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33510,12 +33510,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33542,12 +33542,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33574,12 +33574,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33606,12 +33606,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33638,12 +33638,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33672,13 +33672,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -33739,13 +33739,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -33776,12 +33776,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33829,13 +33829,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Global", @@ -34024,7 +34024,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -34042,7 +34042,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -34111,7 +34111,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -34120,7 +34120,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -34307,7 +34307,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "events": [ @@ -34324,7 +34324,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -34381,7 +34381,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -34389,7 +34389,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -34428,7 +34428,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -34436,7 +34436,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -34488,7 +34488,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" @@ -34500,7 +34500,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com", "id": 1, @@ -34554,7 +34554,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -34563,7 +34563,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "queued" } @@ -34614,7 +34614,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" @@ -34626,7 +34626,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com", "login": "octocat", @@ -34710,7 +34710,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -34719,7 +34719,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "queued" } @@ -34751,13 +34751,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "seats": 1400, "seats_used": 1316, @@ -34794,13 +34794,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "running", "progress": [ @@ -34852,12 +34852,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -34884,13 +34884,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "scheduled", "scheduled_time": "Tuesday, January 22 at 15:34 -0800", @@ -34950,7 +34950,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "maintenance": "{\"enabled\":true, \"when\":\"now\"}" @@ -34959,7 +34959,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "scheduled", "scheduled_time": "Tuesday, January 22 at 15:34 -0800", @@ -35008,13 +35008,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enterprise": { "private_mode": false, @@ -35192,7 +35192,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "settings": "{ \"enterprise\": { \"public_pages\": true }}" @@ -35200,7 +35200,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35227,13 +35227,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -35285,7 +35285,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" @@ -35294,7 +35294,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -35346,7 +35346,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" @@ -35355,7 +35355,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -35425,12 +35425,12 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35468,12 +35468,12 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35559,7 +35559,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -35568,7 +35568,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 42, @@ -35625,7 +35625,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -35635,7 +35635,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -35710,7 +35710,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enforcement": "enabled", @@ -35724,7 +35724,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -35779,7 +35779,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -35789,7 +35789,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -35856,7 +35856,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "github", @@ -35867,7 +35867,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -35929,7 +35929,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "the-new-octocats" @@ -35941,7 +35941,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename organization. It may take a few minutes to complete.", "url": "https:///api/v3/organizations/1" @@ -36022,13 +36022,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -36111,7 +36111,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "DevTools Hook Env", @@ -36121,7 +36121,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -36176,7 +36176,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -36185,7 +36185,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -36260,7 +36260,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -36269,7 +36269,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -36328,7 +36328,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -36336,7 +36336,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36379,7 +36379,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -36388,7 +36388,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "not_started", @@ -36437,7 +36437,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -36446,7 +36446,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "success", @@ -36531,13 +36531,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -36657,7 +36657,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Check Commits", @@ -36675,7 +36675,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -36743,7 +36743,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" @@ -36752,7 +36752,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -36880,7 +36880,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Check Commits", @@ -36896,7 +36896,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -36964,7 +36964,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" @@ -36972,7 +36972,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37069,7 +37069,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37079,7 +37079,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 42, @@ -37144,7 +37144,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37155,7 +37155,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -37234,7 +37234,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enforcement": "enabled" @@ -37248,7 +37248,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -37311,7 +37311,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37322,7 +37322,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Responds with effective values inherited from owner and/or global level.", + "description": "

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

    ", "example": { "id": 42, "name": "Check Commits", @@ -37416,13 +37416,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -37485,7 +37485,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_ids": "KEY_IDS" @@ -37493,7 +37493,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37539,13 +37539,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -37616,7 +37616,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "token_id": "TOKEN_ID" @@ -37624,7 +37624,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37671,7 +37671,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "monalisa", @@ -37681,7 +37681,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -37749,7 +37749,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "thenewmonalisa" @@ -37761,7 +37761,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename user. It may take a few minutes to complete.", "url": "https://api.github.com/user/1" @@ -37802,7 +37802,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -37810,7 +37810,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37861,7 +37861,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -37870,7 +37870,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when getting an existing impersonation OAuth token", + "description": "

    Response when getting an existing impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -37897,7 +37897,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -37906,7 +37906,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when creating a new impersonation OAuth token", + "description": "

    Response when creating a new impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -37967,7 +37967,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -37975,7 +37975,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38012,7 +38012,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -38020,7 +38020,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38057,7 +38057,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -38065,7 +38065,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38113,7 +38113,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -38121,7 +38121,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38169,7 +38169,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -38177,7 +38177,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38236,13 +38236,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -38397,13 +38397,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -38490,13 +38490,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -38613,13 +38613,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -38717,7 +38717,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -38726,7 +38726,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -38856,7 +38856,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -38865,7 +38865,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -38925,7 +38925,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -38933,7 +38933,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39000,7 +39000,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -39009,7 +39009,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", @@ -39108,7 +39108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -39117,7 +39117,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -39214,7 +39214,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -39223,7 +39223,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -39323,7 +39323,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -39331,7 +39331,7 @@ }, "response": { "statusCode": "204", - "description": "Response if gist is starred" + "description": "

    Response if gist is starred

    " } } ], @@ -39380,7 +39380,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -39388,7 +39388,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39437,7 +39437,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -39445,7 +39445,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39503,7 +39503,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -39513,7 +39513,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -39605,7 +39605,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39614,7 +39614,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -39725,7 +39725,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -39734,7 +39734,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -39829,7 +39829,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -39838,7 +39838,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -39925,7 +39925,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -39935,7 +39935,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -40037,7 +40037,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -40047,7 +40047,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -40126,7 +40126,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -40135,7 +40135,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40218,7 +40218,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "Content of the blob", @@ -40232,7 +40232,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" @@ -40307,7 +40307,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40318,7 +40318,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", "encoding": "base64", @@ -40581,7 +40581,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -40604,7 +40604,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -40702,7 +40702,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40713,7 +40713,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", @@ -40827,7 +40827,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40838,7 +40838,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/feature-a", @@ -40916,7 +40916,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40927,7 +40927,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -41018,7 +41018,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "refs/heads/featureA", @@ -41032,7 +41032,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -41123,7 +41123,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", @@ -41138,7 +41138,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -41208,7 +41208,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41218,7 +41218,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41392,7 +41392,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag": "v0.0.1", @@ -41413,7 +41413,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -41495,7 +41495,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41506,7 +41506,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -41734,7 +41734,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -41755,7 +41755,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", @@ -41847,7 +41847,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41858,7 +41858,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -41894,7 +41894,7 @@ { "key": "response-recursively-retrieving-a-tree", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41905,7 +41905,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response recursively retrieving a tree", + "description": "

    Response recursively retrieving a tree

    ", "example": { "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", @@ -41958,13 +41958,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "Actionscript", "Android", @@ -42014,7 +42014,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "name": "NAME" @@ -42023,7 +42023,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" @@ -42198,13 +42198,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -42616,7 +42616,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -42625,7 +42625,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -43056,7 +43056,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43066,7 +43066,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -43397,7 +43397,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -43418,7 +43418,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -43650,7 +43650,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43661,7 +43661,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -44023,7 +44023,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -44046,7 +44046,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -44299,7 +44299,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44309,7 +44309,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -44380,7 +44380,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44390,7 +44390,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -44525,13 +44525,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -44870,7 +44870,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44880,7 +44880,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -44961,7 +44961,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44971,7 +44971,7 @@ }, "response": { "statusCode": "204", - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned." + "description": "

    If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

    " } } ], @@ -45044,7 +45044,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -45061,7 +45061,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -45287,7 +45287,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -45304,7 +45304,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -45564,7 +45564,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45574,7 +45574,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -45672,7 +45672,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45683,7 +45683,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -45787,7 +45787,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -45801,7 +45801,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -45891,7 +45891,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45901,7 +45901,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -45984,7 +45984,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45995,7 +45995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -46104,7 +46104,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -46118,7 +46118,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -46231,7 +46231,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46241,7 +46241,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -46470,7 +46470,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46481,7 +46481,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", @@ -46774,7 +46774,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46785,7 +46785,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -46902,7 +46902,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46913,7 +46913,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -47007,7 +47007,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -47024,7 +47024,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -47122,7 +47122,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -47139,7 +47139,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -47222,7 +47222,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47232,7 +47232,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -47300,7 +47300,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47312,7 +47312,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -47395,7 +47395,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47405,7 +47405,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -47504,7 +47504,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "bug", @@ -47519,7 +47519,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -47591,7 +47591,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47602,7 +47602,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -47699,7 +47699,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "bug :bug:", @@ -47715,7 +47715,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -47779,7 +47779,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47789,7 +47789,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -47862,7 +47862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47873,7 +47873,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -48002,7 +48002,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48012,7 +48012,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", @@ -48145,7 +48145,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -48161,7 +48161,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -48261,7 +48261,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48272,7 +48272,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -48412,7 +48412,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -48429,7 +48429,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -48521,7 +48521,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48531,7 +48531,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -48610,7 +48610,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48620,7 +48620,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -48689,13 +48689,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "mit", @@ -48787,7 +48787,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "license": "LICENSE" @@ -48796,7 +48796,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "mit", "name": "MIT License", @@ -48879,7 +48879,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48889,7 +48889,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "LICENSE", "path": "LICENSE", @@ -48982,12 +48982,12 @@ "key": "200", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49046,12 +49046,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49078,13 +49078,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "verifiable_password_authentication": true, "packages": [ @@ -49135,12 +49135,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49167,12 +49167,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49223,7 +49223,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49233,7 +49233,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "description": "

    Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

    ", "example": [ [ 1302998400, @@ -49294,7 +49294,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49304,7 +49304,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "days": [ @@ -49373,7 +49373,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49383,7 +49383,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "
      \n
    • w - Start of the week, given as a Unix timestamp.
    • \n
    • a - Number of additions
    • \n
    • d - Number of deletions
    • \n
    • c - Number of commits
    • \n
    ", "example": [ { "author": { @@ -49470,7 +49470,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49480,7 +49480,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The array order is oldest week (index 0) to most recent week.", + "description": "

    The array order is oldest week (index 0) to most recent week.

    ", "example": { "all": [ 11, @@ -49640,7 +49640,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49650,7 +49650,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "description": "

    For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

    ", "example": [ [ 0, @@ -49729,13 +49729,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -49804,7 +49804,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -49813,7 +49813,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/applications/grants/1", @@ -49876,7 +49876,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -49884,7 +49884,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49951,13 +49951,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -50105,13 +50105,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -50254,7 +50254,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -50263,7 +50263,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -50290,7 +50290,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -50299,7 +50299,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.1/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.1/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "description": "

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

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -50442,7 +50442,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -50452,7 +50452,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -50479,7 +50479,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -50489,7 +50489,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response if returning a new token", + "description": "

    Response if returning a new token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -50554,7 +50554,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -50563,7 +50563,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -50707,7 +50707,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -50716,7 +50716,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -50777,7 +50777,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -50785,7 +50785,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50847,13 +50847,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -50910,7 +50910,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -50919,7 +50919,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "github", "id": 1, @@ -51185,7 +51185,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "billing_email": "mona@github.com", @@ -51206,7 +51206,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -51323,7 +51323,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -51332,7 +51332,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "installations": [ @@ -51434,13 +51434,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -51523,7 +51523,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -51532,7 +51532,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -51635,7 +51635,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -51644,7 +51644,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -51720,7 +51720,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51729,7 +51729,7 @@ }, "response": { "statusCode": "204", - "description": "Response if requester is an organization member and user is a member" + "description": "

    Response if requester is an organization member and user is a member

    " } } ], @@ -51783,7 +51783,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51792,7 +51792,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51842,7 +51842,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51852,7 +51852,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -51962,7 +51962,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51972,7 +51972,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -52066,7 +52066,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -52075,7 +52075,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52138,7 +52138,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52147,7 +52147,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -52215,7 +52215,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -52224,7 +52224,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a public member" + "description": "

    Response if user is a public member

    " } } ], @@ -52274,7 +52274,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -52283,7 +52283,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52333,7 +52333,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -52342,7 +52342,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52401,13 +52401,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", @@ -52542,7 +52542,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52551,7 +52551,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", @@ -52650,7 +52650,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "active" @@ -52662,7 +52662,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -52785,7 +52785,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52794,7 +52794,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -52862,7 +52862,7 @@ { "key": "202", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -52871,13 +52871,13 @@ }, "response": { "statusCode": "202", - "description": "User is getting converted asynchronously" + "description": "

    User is getting converted asynchronously

    " } }, { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -52886,7 +52886,7 @@ }, "response": { "statusCode": "204", - "description": "User was converted" + "description": "

    User was converted

    " } } ], @@ -52944,7 +52944,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -52953,7 +52953,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53014,7 +53014,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -53023,7 +53023,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -53298,7 +53298,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -53319,7 +53319,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -53391,7 +53391,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53401,7 +53401,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -53641,7 +53641,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -53657,7 +53657,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -53728,7 +53728,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53737,7 +53737,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53787,7 +53787,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53797,7 +53797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -53907,7 +53907,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53917,7 +53917,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -53969,7 +53969,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53978,7 +53978,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54031,7 +54031,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54041,7 +54041,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -54182,7 +54182,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "source": { @@ -54198,7 +54198,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -54347,7 +54347,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "cname": "octocatblog.com", @@ -54363,7 +54363,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54417,7 +54417,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54426,7 +54426,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54500,7 +54500,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54510,7 +54510,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", @@ -54589,7 +54589,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54599,7 +54599,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", "status": "queued" @@ -54649,7 +54649,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54659,7 +54659,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -54745,7 +54745,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54756,7 +54756,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -54861,7 +54861,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -54870,7 +54870,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -54969,7 +54969,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Organization Roadmap", @@ -54982,7 +54982,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -55075,7 +55075,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -55084,7 +55084,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -55234,7 +55234,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -55243,7 +55243,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -55340,7 +55340,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -55348,7 +55348,7 @@ }, "response": { "statusCode": "204", - "description": "Delete Success" + "description": "

    Delete Success

    " } } ], @@ -55449,7 +55449,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -55459,7 +55459,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", @@ -55583,7 +55583,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Projects Documentation", @@ -55597,7 +55597,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -55709,13 +55709,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", @@ -55841,7 +55841,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -55850,7 +55850,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/users/octocat", @@ -55932,7 +55932,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -55941,7 +55941,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -56057,7 +56057,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -56066,7 +56066,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -56157,7 +56157,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -56165,7 +56165,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56247,7 +56247,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -56255,7 +56255,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56347,7 +56347,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -56356,7 +56356,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/cards/1478", @@ -56482,7 +56482,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -56491,7 +56491,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -56617,7 +56617,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -56626,7 +56626,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -56736,7 +56736,7 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -56745,7 +56745,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56813,7 +56813,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -56822,7 +56822,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56890,7 +56890,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -56900,7 +56900,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "permission": "admin", "user": { @@ -56984,7 +56984,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -56993,7 +56993,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -57072,7 +57072,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -57081,7 +57081,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -57142,7 +57142,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -57150,7 +57150,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -57216,7 +57216,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -57224,7 +57224,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -57297,7 +57297,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -57306,7 +57306,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/367", @@ -57383,7 +57383,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -57392,7 +57392,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -57549,7 +57549,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57559,7 +57559,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -58198,7 +58198,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Amazing new feature", @@ -58214,7 +58214,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -58810,7 +58810,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58821,7 +58821,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "

    Pass the appropriate media type to fetch diff and patch formats.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -59472,7 +59472,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "new title", @@ -59489,7 +59489,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -60103,7 +60103,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60114,7 +60114,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -60267,7 +60267,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60278,7 +60278,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", @@ -60355,7 +60355,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60365,7 +60365,7 @@ }, "response": { "statusCode": "204", - "description": "Response if pull request has been merged" + "description": "

    Response if pull request has been merged

    " } } ], @@ -60467,7 +60467,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60478,7 +60478,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if merge was successful", + "description": "

    if merge was successful

    ", "example": { "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "merged": true, @@ -60569,7 +60569,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" @@ -60583,7 +60583,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Updating pull request branch.", "url": "https://github.com/repos/octocat/Hello-World/pulls/53" @@ -60701,7 +60701,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60711,7 +60711,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -60827,7 +60827,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60838,7 +60838,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -60967,7 +60967,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "I like this too!" @@ -60981,7 +60981,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -61094,7 +61094,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61104,7 +61104,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -61218,7 +61218,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61229,7 +61229,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -61370,6 +61370,10 @@ { "type": "integer", "description": "

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + }, "name": "position", "in": "body", "rawType": "integer", @@ -61440,7 +61444,7 @@ "key": "example-for-a-multi-line-comment", "request": { "contentType": "application/json", - "description": "Example for a multi-line comment", + "description": "

    Example for a multi-line comment

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!", @@ -61460,7 +61464,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -61601,7 +61605,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!" @@ -61616,7 +61620,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -61751,7 +61755,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61762,7 +61766,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "users": [ { @@ -61883,7 +61887,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -61904,7 +61908,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -62544,7 +62548,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -62564,7 +62568,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -62643,7 +62647,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62654,7 +62658,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The list of reviews returns in chronological order.", + "description": "

    The list of reviews returns in chronological order.

    ", "example": [ { "id": 80, @@ -62952,7 +62956,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", @@ -62975,7 +62979,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -63086,7 +63090,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63098,7 +63102,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -63216,7 +63220,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is close to perfect! Please address the suggested inline change. And add more about this." @@ -63231,7 +63235,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -63338,7 +63342,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63350,7 +63354,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -63479,7 +63483,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63491,7 +63495,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -63633,7 +63637,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63645,7 +63649,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -63781,7 +63785,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63793,7 +63797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -63874,13 +63878,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "resources": { "core": { @@ -64033,7 +64037,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -64045,7 +64049,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -64160,7 +64164,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -64175,7 +64179,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "

    Response when the reaction type has already been added to this team discussion comment

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -64208,7 +64212,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -64223,7 +64227,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -64328,7 +64332,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -64340,7 +64344,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64434,7 +64438,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -64445,7 +64449,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -64551,7 +64555,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -64565,7 +64569,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -64598,7 +64602,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -64612,7 +64616,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -64708,7 +64712,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -64719,7 +64723,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64758,7 +64762,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "reaction_id": "REACTION_ID" @@ -64766,7 +64770,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64876,7 +64880,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64887,7 +64891,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -64997,7 +65001,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -65011,7 +65015,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -65044,7 +65048,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -65058,7 +65062,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -65162,7 +65166,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65173,7 +65177,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -65267,7 +65271,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65278,7 +65282,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -65388,7 +65392,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -65402,7 +65406,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -65435,7 +65439,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -65449,7 +65453,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -65549,7 +65553,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65560,7 +65564,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -65654,7 +65658,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65665,7 +65669,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -65779,7 +65783,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -65793,7 +65797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -65826,7 +65830,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -65840,7 +65844,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -65940,7 +65944,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65951,7 +65955,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66045,7 +66049,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66056,7 +66060,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -66166,7 +66170,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66180,7 +66184,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66213,7 +66217,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66227,7 +66231,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66327,7 +66331,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66338,7 +66342,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66432,7 +66436,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -66443,7 +66447,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -66549,7 +66553,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66563,7 +66567,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66674,7 +66678,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -66684,7 +66688,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -66781,7 +66785,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66794,7 +66798,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66846,6 +66850,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -66890,7 +66895,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66900,7 +66905,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", @@ -66991,8 +66996,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67000,6 +67004,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67084,7 +67089,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -67102,7 +67107,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -67192,8 +67197,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67201,6 +67205,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67227,7 +67232,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67237,7 +67242,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -67323,8 +67328,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67332,6 +67336,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67368,7 +67373,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67379,7 +67384,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -67469,8 +67474,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67478,6 +67482,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67513,7 +67518,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67524,7 +67529,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#hypermedia).", + "description": "

    Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -67614,8 +67619,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67623,6 +67627,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67714,7 +67719,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -67733,7 +67738,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -67819,8 +67824,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67828,6 +67832,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67863,7 +67868,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67873,7 +67878,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67884,8 +67889,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ @@ -67931,7 +67935,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67942,7 +67946,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "

    To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -68070,7 +68074,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "foo-1.0.0-osx.zip", @@ -68085,7 +68089,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -68174,7 +68178,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68184,7 +68188,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68257,7 +68261,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68268,7 +68272,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", @@ -68377,7 +68381,7 @@ "key": "default", "request": { "contentType": "*/*", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68388,7 +68392,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for successful upload", + "description": "

    Response for successful upload

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -68531,7 +68535,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -68540,7 +68544,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -68856,7 +68860,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -68874,7 +68878,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -69051,7 +69055,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69061,7 +69065,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -69566,7 +69570,7 @@ { "key": "response-with-scarlet-witch-preview-media-type", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69576,7 +69580,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with scarlet-witch-preview media type", + "description": "

    Response with scarlet-witch-preview media type

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -70304,7 +70308,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -70323,7 +70327,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -70889,7 +70893,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70898,7 +70902,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70983,7 +70987,7 @@ { "key": "response-if-repository-contains-content", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70993,7 +70997,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if repository contains content", + "description": "

    if repository contains content

    ", "example": [ { "login": "octocat", @@ -71098,7 +71102,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "event_type": "on-demand-test", @@ -71114,7 +71118,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71164,7 +71168,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71174,7 +71178,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "C": 78769, "Python": 7769 @@ -71242,7 +71246,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71252,7 +71256,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "v0.1", @@ -71328,7 +71332,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71338,7 +71342,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -71418,7 +71422,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71428,7 +71432,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -71506,7 +71510,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "names": [ @@ -71524,7 +71528,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -71615,7 +71619,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_owner": "github", @@ -71632,7 +71636,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -71950,7 +71954,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "owner": "octocat", @@ -71967,7 +71971,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -72138,13 +72142,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -72360,13 +72364,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -72735,13 +72739,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -72987,7 +72991,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -72996,7 +73000,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -73172,7 +73176,7 @@ { "key": "response-if-content-is-a-file", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73183,7 +73187,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a file", + "description": "

    Response if content is a file

    ", "example": { "type": "file", "encoding": "base64", @@ -73207,7 +73211,7 @@ { "key": "response-if-content-is-a-directory", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73218,7 +73222,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a directory", + "description": "

    Response if content is a directory

    ", "example": [ { "type": "file", @@ -73258,7 +73262,7 @@ { "key": "response-if-content-is-a-symlink", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73269,7 +73273,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a symlink", + "description": "

    Response if content is a symlink

    ", "example": { "type": "symlink", "target": "/path/to/symlink/target", @@ -73292,7 +73296,7 @@ { "key": "response-if-content-is-a-submodule", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73303,7 +73307,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a submodule", + "description": "

    Response if content is a submodule

    ", "example": { "type": "submodule", "submodule_git_url": "git://github.com/jquery/qunit.git", @@ -73588,7 +73592,7 @@ "key": "example-for-creating-a-file", "request": { "contentType": "application/json", - "description": "Example for creating a file", + "description": "

    Example for creating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -73607,7 +73611,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -73666,7 +73670,7 @@ "key": "example-for-updating-a-file", "request": { "contentType": "application/json", - "description": "Example for updating a file", + "description": "

    Example for updating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "a new commit message", @@ -73686,7 +73690,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -73949,7 +73953,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -73968,7 +73972,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": null, "commit": { @@ -74076,7 +74080,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74086,7 +74090,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -74177,7 +74181,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74188,7 +74192,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -74269,7 +74273,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74279,7 +74283,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -74334,7 +74338,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74344,7 +74348,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -74426,7 +74430,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74436,7 +74440,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -74613,7 +74617,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74623,7 +74627,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -75224,13 +75228,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 7, "incomplete_results": false, @@ -75410,13 +75414,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "incomplete_results": false, @@ -75641,13 +75645,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 280, "incomplete_results": false, @@ -75854,13 +75858,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "incomplete_results": false, @@ -75986,13 +75990,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 40, "incomplete_results": false, @@ -76171,13 +76175,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 6, "incomplete_results": false, @@ -76354,13 +76358,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 12, "incomplete_results": false, @@ -76498,7 +76502,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76508,7 +76512,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -76618,7 +76622,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76629,7 +76633,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -76742,7 +76746,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "resolved", @@ -76757,7 +76761,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -76860,7 +76864,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -76869,7 +76873,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -77015,7 +77019,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Justice League", @@ -77030,7 +77034,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -77131,7 +77135,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -77141,7 +77145,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -77298,7 +77302,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -77313,7 +77317,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -77406,7 +77410,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -77415,7 +77419,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77479,7 +77483,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -77489,7 +77493,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -77589,7 +77593,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -77600,7 +77604,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -77718,7 +77722,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -77728,7 +77732,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77789,7 +77793,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -77799,7 +77803,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77863,7 +77867,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -77873,7 +77877,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -78043,7 +78047,7 @@ { "key": "alternative-response-with-repository-permissions", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -78055,7 +78059,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with repository permissions", + "description": "

    Alternative response with repository permissions

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -78390,7 +78394,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -78401,7 +78405,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -78465,7 +78469,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -78476,7 +78480,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -78540,7 +78544,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -78550,7 +78554,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -78615,7 +78619,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -78624,7 +78628,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -78772,7 +78776,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -78786,7 +78790,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the updated information already exists", + "description": "

    Response when the updated information already exists

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -78840,7 +78844,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -78854,7 +78858,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -78954,7 +78958,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -78962,7 +78966,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -79025,7 +79029,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -79034,7 +79038,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -79129,7 +79133,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -79139,7 +79143,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -79248,7 +79252,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -79257,7 +79261,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -79317,7 +79321,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -79326,7 +79330,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -79389,7 +79393,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -79398,7 +79402,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -79563,7 +79567,7 @@ { "key": "alternative-response-with-extra-repository-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -79574,7 +79578,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with extra repository information", + "description": "

    Alternative response with extra repository information

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -79897,7 +79901,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -79907,7 +79911,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -79970,7 +79974,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -79980,7 +79984,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80035,7 +80039,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -80044,7 +80048,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -80130,13 +80134,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -80287,7 +80291,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80298,7 +80302,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -80413,7 +80417,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -80427,7 +80431,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -80538,7 +80542,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80550,7 +80554,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -80672,7 +80676,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -80687,7 +80691,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -80798,7 +80802,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80809,7 +80813,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80887,7 +80891,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -80897,7 +80901,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -81003,7 +81007,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -81016,7 +81020,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -81118,7 +81122,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81129,7 +81133,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -81242,7 +81246,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -81256,7 +81260,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -81358,7 +81362,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81368,7 +81372,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81457,7 +81461,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81467,7 +81471,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -81597,7 +81601,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -81611,7 +81615,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -81718,7 +81722,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81729,7 +81733,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -81856,7 +81860,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -81870,7 +81874,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -81977,7 +81981,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81987,7 +81991,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82056,7 +82060,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -82065,7 +82069,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -82186,7 +82190,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -82199,7 +82203,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -82297,7 +82301,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -82307,7 +82311,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -82425,7 +82429,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -82438,7 +82442,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -82536,7 +82540,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -82545,7 +82549,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82626,7 +82630,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -82636,7 +82640,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -82713,7 +82717,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -82724,7 +82728,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -82804,7 +82808,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -82815,7 +82819,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -82883,7 +82887,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -82893,7 +82897,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82967,7 +82971,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -82976,7 +82980,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -83048,7 +83052,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83057,7 +83061,7 @@ }, "response": { "statusCode": "204", - "description": "if user is a member" + "description": "

    if user is a member

    " } } ], @@ -83107,7 +83111,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83116,7 +83120,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83174,7 +83178,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83183,7 +83187,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83233,7 +83237,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83243,7 +83247,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -83314,7 +83318,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83324,7 +83328,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -83387,7 +83391,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83396,7 +83400,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83430,13 +83434,13 @@ { "key": "response-with-public-and-private-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public and private profile information", + "description": "

    Response with public and private profile information

    ", "example": { "login": "octocat", "id": 1, @@ -83487,13 +83491,13 @@ { "key": "response-with-public-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public profile information", + "description": "

    Response with public profile information

    ", "example": { "login": "octocat", "id": 1, @@ -83660,13 +83664,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -83777,13 +83781,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -83846,7 +83850,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -83855,7 +83859,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "octocat", "id": 1, @@ -83895,7 +83899,7 @@ { "key": "response-with-git-hub-plan-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -83904,7 +83908,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with GitHub plan information", + "description": "

    Response with GitHub plan information

    ", "example": { "login": "octocat", "id": 1, @@ -84009,7 +84013,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -84018,7 +84022,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "contexts": [ { @@ -84083,13 +84087,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -84159,13 +84163,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@octocat.org", @@ -84250,12 +84254,12 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84321,13 +84325,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -84399,13 +84403,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -84485,13 +84489,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -84562,7 +84566,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -84570,7 +84574,7 @@ }, "response": { "statusCode": "204", - "description": "if the person is followed by the authenticated user" + "description": "

    if the person is followed by the authenticated user

    " } } ], @@ -84623,7 +84627,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -84631,7 +84635,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84684,7 +84688,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -84692,7 +84696,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84763,7 +84767,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -84772,7 +84776,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -84849,7 +84853,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -84858,7 +84862,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -84926,7 +84930,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -84935,7 +84939,7 @@ }, "response": { "statusCode": "204", - "description": "if the user follows the target user" + "description": "

    if the user follows the target user

    " } } ], @@ -84987,13 +84991,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -85084,13 +85088,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -85182,7 +85186,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -85191,7 +85195,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -85279,7 +85283,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -85287,7 +85291,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85362,7 +85366,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -85371,7 +85375,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -85456,13 +85460,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -85549,13 +85553,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -85621,7 +85625,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -85630,7 +85634,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -85692,7 +85696,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -85700,7 +85704,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85771,7 +85775,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -85780,7 +85784,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -85845,7 +85849,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85856,7 +85860,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -85975,7 +85979,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85986,7 +85990,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -86058,7 +86062,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -86068,7 +86072,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Repository", @@ -86356,7 +86360,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -86379,7 +86383,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -86471,7 +86475,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -86482,7 +86486,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -86795,7 +86799,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -86812,7 +86816,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -86900,7 +86904,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -86910,7 +86914,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -86969,7 +86973,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -86979,7 +86983,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87038,7 +87042,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -87048,7 +87052,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index aac7c2ddb7..97eb89c836 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -52,7 +52,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62,7 +62,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -146,7 +146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -157,7 +157,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 11, "node_id": "MDg6QXJ0aWZhY3QxMQ==", @@ -224,7 +224,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -234,7 +234,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -298,7 +298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -309,7 +309,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -382,7 +382,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -393,7 +393,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -461,7 +461,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -470,7 +470,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_organizations": "all", "allowed_actions": "selected", @@ -542,7 +542,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_organizations": "all", @@ -554,7 +554,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -609,7 +609,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -618,7 +618,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -689,7 +689,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -703,7 +703,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -749,7 +749,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -758,7 +758,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -804,7 +804,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -813,7 +813,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -850,7 +850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -859,7 +859,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -927,7 +927,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -943,7 +943,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -980,7 +980,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -989,7 +989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_repositories": "all", "allowed_actions": "selected", @@ -1061,7 +1061,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_repositories": "all", @@ -1073,7 +1073,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1128,7 +1128,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1137,7 +1137,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -1317,7 +1317,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -1331,7 +1331,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1377,7 +1377,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1386,7 +1386,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1432,7 +1432,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1441,7 +1441,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1478,7 +1478,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1487,7 +1487,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1555,7 +1555,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1571,7 +1571,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1617,7 +1617,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1627,7 +1627,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled": true, "allowed_actions": "selected", @@ -1703,7 +1703,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled": true, @@ -1716,7 +1716,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1762,7 +1762,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1772,7 +1772,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1849,7 +1849,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1866,7 +1866,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1923,7 +1923,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1932,7 +1932,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "secrets": [ @@ -1993,7 +1993,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -2002,7 +2002,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2052,7 +2052,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2062,7 +2062,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2162,7 +2162,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2180,14 +2180,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2205,7 +2205,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -2255,7 +2255,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2264,7 +2264,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2328,7 +2328,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2338,7 +2338,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -2472,7 +2472,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -2486,7 +2486,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2541,7 +2541,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2551,7 +2551,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -2610,7 +2610,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2620,7 +2620,7 @@ }, "response": { "statusCode": "204", - "description": "Response when repository was removed from the selected list" + "description": "

    Response when repository was removed from the selected list

    " } } ], @@ -2688,7 +2688,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2698,7 +2698,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -2759,7 +2759,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2769,7 +2769,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2828,7 +2828,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2839,7 +2839,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2920,7 +2920,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2934,14 +2934,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2955,7 +2955,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3014,7 +3014,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3024,7 +3024,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3088,7 +3088,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3098,7 +3098,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -3159,7 +3159,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3169,7 +3169,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -3228,7 +3228,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3239,7 +3239,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -3320,7 +3320,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3334,14 +3334,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3355,7 +3355,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3414,7 +3414,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3424,7 +3424,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -3481,7 +3481,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -3490,7 +3490,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -3617,7 +3617,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3638,7 +3638,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3693,7 +3693,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3703,7 +3703,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3793,7 +3793,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3807,7 +3807,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "Expensive hardware runners", @@ -3862,7 +3862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3871,7 +3871,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3935,7 +3935,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3945,7 +3945,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -4025,7 +4025,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -4040,7 +4040,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4095,7 +4095,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4105,7 +4105,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4160,7 +4160,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4170,7 +4170,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4234,7 +4234,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4244,7 +4244,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -4363,7 +4363,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -4378,7 +4378,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4433,7 +4433,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4443,7 +4443,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4498,7 +4498,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4508,7 +4508,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4563,7 +4563,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -4572,7 +4572,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -4704,7 +4704,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4725,7 +4725,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4781,7 +4781,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4791,7 +4791,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4882,7 +4882,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4896,7 +4896,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4952,7 +4952,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4961,7 +4961,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5025,7 +5025,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5035,7 +5035,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -5342,7 +5342,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -5357,7 +5357,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5412,7 +5412,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5422,7 +5422,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5477,7 +5477,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5487,7 +5487,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5551,7 +5551,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5561,7 +5561,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5680,7 +5680,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -5695,7 +5695,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5750,7 +5750,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5760,7 +5760,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5815,7 +5815,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5825,7 +5825,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5882,7 +5882,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5891,7 +5891,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5986,7 +5986,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5995,7 +5995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -6074,7 +6074,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6083,7 +6083,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -6124,7 +6124,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6133,7 +6133,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -6183,7 +6183,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6193,7 +6193,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -6268,7 +6268,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6277,7 +6277,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6332,7 +6332,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6341,7 +6341,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6436,7 +6436,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6445,7 +6445,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -6524,7 +6524,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6533,7 +6533,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -6574,7 +6574,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6583,7 +6583,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -6633,7 +6633,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6643,7 +6643,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -6718,7 +6718,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6727,7 +6727,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6791,7 +6791,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6801,7 +6801,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6905,7 +6905,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6915,7 +6915,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -7003,7 +7003,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7013,7 +7013,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -7063,7 +7063,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7073,7 +7073,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -7132,7 +7132,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7143,7 +7143,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -7227,7 +7227,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7237,7 +7237,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7294,7 +7294,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7305,7 +7305,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 399444496, "run_id": 29679449, @@ -7457,7 +7457,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7467,7 +7467,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7554,7 +7554,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7565,7 +7565,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "jobs": [ @@ -7813,7 +7813,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7823,7 +7823,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -8069,7 +8069,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8080,7 +8080,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 30433642, "name": "Build", @@ -8310,7 +8310,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8320,7 +8320,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8375,7 +8375,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8386,7 +8386,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "state": "approved", @@ -8478,7 +8478,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8488,7 +8488,7 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8547,7 +8547,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8557,7 +8557,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8612,7 +8612,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8622,7 +8622,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8685,7 +8685,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8696,7 +8696,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "environment": { @@ -8856,7 +8856,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8867,7 +8867,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -8962,7 +8962,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8972,7 +8972,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9123,7 +9123,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9134,7 +9134,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -9381,7 +9381,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9391,7 +9391,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "workflows": [ @@ -9482,7 +9482,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9493,7 +9493,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", @@ -9567,7 +9567,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9577,7 +9577,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9663,7 +9663,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -9680,7 +9680,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9742,7 +9742,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9752,7 +9752,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9802,12 +9802,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9883,7 +9883,7 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9892,7 +9892,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9963,7 +9963,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -9971,7 +9971,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10035,7 +10035,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10044,7 +10044,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10099,7 +10099,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10107,7 +10107,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10171,7 +10171,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -10180,7 +10180,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10235,7 +10235,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10243,7 +10243,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10298,7 +10298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10306,7 +10306,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10361,7 +10361,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10369,7 +10369,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10398,13 +10398,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", @@ -10536,13 +10536,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -10692,24 +10692,24 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -10762,7 +10762,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10771,7 +10771,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": "1", "repository": { @@ -10904,7 +10904,7 @@ { "key": "205", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10912,7 +10912,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -10957,7 +10957,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10966,7 +10966,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -11035,7 +11035,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -11044,7 +11044,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -11101,7 +11101,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -11109,7 +11109,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11225,7 +11225,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11235,7 +11235,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -11379,7 +11379,7 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11388,14 +11388,14 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11404,7 +11404,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -11474,7 +11474,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11484,7 +11484,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "login": "octocat", @@ -11512,7 +11512,7 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11522,7 +11522,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -11625,13 +11625,13 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -11762,13 +11762,13 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/vnd.github.v3.star+json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -11954,7 +11954,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11963,7 +11963,7 @@ }, "response": { "statusCode": "204", - "description": "Response if this repository is starred by you" + "description": "

    Response if this repository is starred by you

    " } } ], @@ -12025,7 +12025,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12034,7 +12034,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12096,7 +12096,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12105,7 +12105,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12204,7 +12204,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -12213,7 +12213,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -12404,7 +12404,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12414,7 +12414,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -12482,7 +12482,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12492,7 +12492,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if you subscribe to the repository", + "description": "

    if you subscribe to the repository

    ", "example": { "subscribed": true, "ignored": false, @@ -12574,7 +12574,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12584,7 +12584,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -12638,7 +12638,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12647,7 +12647,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12693,13 +12693,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -12872,7 +12872,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -12881,7 +12881,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -13017,13 +13017,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -13101,7 +13101,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "code": "CODE" @@ -13110,7 +13110,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -13228,13 +13228,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "The permissions the installation has are included under the `permissions` key.", + "description": "

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

    ", "example": [ { "id": 1, @@ -13328,7 +13328,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -13337,7 +13337,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -13433,7 +13433,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -13441,7 +13441,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14351,7 +14351,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "respoitory": "Hello-World", @@ -14367,7 +14367,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", @@ -14559,7 +14559,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -14567,7 +14567,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14613,7 +14613,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -14621,7 +14621,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14662,7 +14662,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "app_slug": "APP_SLUG" @@ -14671,7 +14671,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -14757,7 +14757,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -14766,7 +14766,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -14862,7 +14862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14872,7 +14872,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -14967,7 +14967,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -14976,7 +14976,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -15075,13 +15075,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -15245,12 +15245,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15333,7 +15333,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15344,7 +15344,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 101, "title": "[A-1234] Error found in core/models.py file'", @@ -15421,13 +15421,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "You can find the permissions for the installation under the `permissions` key.", + "description": "

    You can find the permissions for the installation under the permissions key.

    ", "example": { "total_count": 2, "installations": [ @@ -15604,7 +15604,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -15613,7 +15613,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "description": "

    The access the user has to each repository is included in the hash under the permissions key.

    ", "example": { "total_count": 1, "repositories": [ @@ -15806,7 +15806,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -15815,7 +15815,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15878,7 +15878,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -15887,7 +15887,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15954,7 +15954,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -15965,7 +15965,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16020,7 +16020,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -16029,7 +16029,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16082,7 +16082,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -16094,7 +16094,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -16197,7 +16197,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -16209,7 +16209,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -16308,7 +16308,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -16319,7 +16319,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17265,7 +17265,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", @@ -17283,7 +17283,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -17421,7 +17421,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -17431,7 +17431,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -17528,7 +17528,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -17538,7 +17538,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -17631,7 +17631,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -17640,7 +17640,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17669,13 +17669,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -17766,7 +17766,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content_type": "json", @@ -17778,7 +17778,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -17830,13 +17830,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -17909,7 +17909,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -17918,7 +17918,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -18006,7 +18006,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -18014,7 +18014,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -18045,6 +18045,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18098,7 +18099,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18108,7 +18109,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "master", @@ -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", @@ -18188,7 +18189,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18198,7 +18199,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -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", @@ -18273,7 +18274,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "my_renamed_branch" @@ -18287,7 +18288,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "master", "commit": { @@ -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", @@ -18474,7 +18475,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base": "master", @@ -18489,7 +18490,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Successful Response (The resulting merge commit)", + "description": "

    Successful Response (The resulting merge commit)

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -18615,8 +18616,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -18663,7 +18663,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18674,7 +18674,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", "required_status_checks": { @@ -19523,7 +19523,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "required_status_checks": { @@ -19579,7 +19579,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19649,7 +19649,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19659,7 +19659,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19719,7 +19719,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19730,7 +19730,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -19790,7 +19790,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19801,7 +19801,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -19861,7 +19861,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19871,7 +19871,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19931,7 +19931,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19942,7 +19942,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -20145,7 +20145,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "dismissal_restrictions": { @@ -20177,7 +20177,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -20288,7 +20288,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20298,7 +20298,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20358,7 +20358,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20369,7 +20369,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -20435,7 +20435,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20446,7 +20446,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -20512,7 +20512,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20522,7 +20522,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20584,7 +20584,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20595,7 +20595,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -20687,7 +20687,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "strict": true, @@ -20704,7 +20704,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -20776,7 +20776,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20786,7 +20786,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20842,7 +20842,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20853,7 +20853,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -20930,7 +20930,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20941,7 +20941,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci", "continuous-integration/jenkins" @@ -21027,7 +21027,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21038,7 +21038,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -21119,7 +21119,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21130,7 +21130,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -21197,7 +21197,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21208,7 +21208,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", @@ -21349,7 +21349,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21359,7 +21359,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -21415,7 +21415,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21426,7 +21426,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21543,7 +21543,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21554,7 +21554,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21671,7 +21671,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21682,7 +21682,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21799,7 +21799,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21810,7 +21810,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21913,7 +21913,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21924,7 +21924,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -22014,7 +22014,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22025,7 +22025,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -22115,7 +22115,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22126,7 +22126,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -22216,7 +22216,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22227,7 +22227,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -22303,7 +22303,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22314,7 +22314,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -22410,7 +22410,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22421,7 +22421,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -22517,7 +22517,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22528,7 +22528,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -22624,7 +22624,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22635,7 +22635,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -23663,7 +23663,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Example of an in_progress conclusion", + "description": "

    Example of an in_progress conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -23685,7 +23685,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "

    Response for in_progress conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -23782,7 +23782,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Example of a completed conclusion", + "description": "

    Example of a completed conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -23838,7 +23838,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "

    Response for completed conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -23983,7 +23983,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23994,7 +23994,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25080,7 +25080,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -25129,7 +25129,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25292,7 +25292,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25303,7 +25303,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "path": "README.md", @@ -25427,7 +25427,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25438,7 +25438,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -25653,7 +25653,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25664,7 +25664,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -25818,7 +25818,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -25831,7 +25831,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the suite already exists", + "description": "

    Response when the suite already exists

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -26138,7 +26138,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -26151,7 +26151,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the suite was created", + "description": "

    Response when the suite was created

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -26567,7 +26567,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "auto_trigger_checks": [ @@ -26585,7 +26585,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "preferences": { "auto_trigger_checks": [ @@ -26879,7 +26879,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26890,7 +26890,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -27245,7 +27245,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27255,7 +27255,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -27348,7 +27348,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27359,7 +27359,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_suites": [ @@ -27658,7 +27658,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27668,7 +27668,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 4, @@ -27840,7 +27840,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27851,7 +27851,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-06-19T11:21:34Z", @@ -28020,7 +28020,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", @@ -28036,7 +28036,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-08-25T21:28:36Z", @@ -28200,7 +28200,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28211,7 +28211,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -28376,7 +28376,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28386,7 +28386,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -28497,7 +28497,7 @@ { "key": "response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28508,7 +28508,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "ref": "refs/heads/main", "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", @@ -28608,7 +28608,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28619,7 +28619,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" @@ -28749,7 +28749,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28759,7 +28759,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -28838,7 +28838,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28849,7 +28849,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "processing_status": "complete", "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -28896,13 +28896,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "citizen_code_of_conduct", @@ -28957,7 +28957,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key": "KEY" @@ -28966,7 +28966,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "contributor_covenant", "name": "Contributor Covenant", @@ -29005,6 +29005,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29064,7 +29065,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29074,7 +29075,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -29116,8 +29117,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29125,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", @@ -29160,7 +29161,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29170,7 +29171,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a collaborator" + "description": "

    Response if user is a collaborator

    " } } ], @@ -29185,8 +29186,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29194,6 +29194,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29259,7 +29260,7 @@ "key": "response-when-a-new-invitation-is-created", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29270,7 +29271,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when a new invitation is created", + "description": "

    Response when a new invitation is created

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -29410,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", @@ -29419,6 +29419,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29454,7 +29455,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29464,7 +29465,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -29475,8 +29476,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29484,6 +29484,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29519,7 +29520,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29530,7 +29531,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if user has admin permissions", + "description": "

    if user has admin permissions

    ", "example": { "permission": "admin", "user": { @@ -29568,8 +29569,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -29624,7 +29624,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29634,7 +29634,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -29826,7 +29826,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29837,7 +29837,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -30010,7 +30010,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30020,7 +30020,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -30066,13 +30066,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -30244,7 +30244,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -30252,7 +30252,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -30305,7 +30305,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -30313,7 +30313,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -30352,6 +30352,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30443,7 +30444,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30453,7 +30454,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -30560,8 +30561,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30569,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", @@ -30605,7 +30606,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30616,7 +30617,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "branch_5", @@ -30643,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", @@ -30652,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", @@ -30706,7 +30707,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30717,7 +30718,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -31250,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", @@ -31259,6 +31259,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31313,7 +31314,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31324,7 +31325,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -31442,8 +31443,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31451,6 +31451,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31504,7 +31505,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31515,7 +31516,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", @@ -31795,8 +31796,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -31851,7 +31851,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31861,7 +31861,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -31954,7 +31954,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31965,7 +31965,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -32071,7 +32071,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Nice change" @@ -32085,7 +32085,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -32178,7 +32178,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32188,7 +32188,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32266,7 +32266,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32277,7 +32277,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -32409,7 +32409,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff", @@ -32426,7 +32426,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -32544,7 +32544,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32555,7 +32555,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "state": "success", "statuses": [ @@ -32735,7 +32735,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32746,7 +32746,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -32885,7 +32885,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "success", @@ -32902,7 +32902,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", @@ -32949,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", @@ -33002,7 +33001,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33012,7 +33011,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -33034,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", @@ -33098,7 +33097,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "octocat@octomac", @@ -33113,7 +33112,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -33137,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", @@ -33181,7 +33180,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33192,7 +33191,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -33216,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", @@ -33260,7 +33259,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33270,7 +33269,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33281,7 +33280,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -33293,6 +33293,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33380,7 +33381,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33390,7 +33391,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -33443,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", @@ -33452,6 +33452,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33581,7 +33582,7 @@ "key": "simple-example", "request": { "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -33596,7 +33597,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -33659,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", @@ -33668,6 +33668,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33703,7 +33704,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33714,7 +33715,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -33770,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", @@ -33779,6 +33779,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33814,7 +33815,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33824,7 +33825,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33843,8 +33844,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -33899,7 +33899,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33909,7 +33909,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "environments": [ @@ -34042,7 +34042,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34053,7 +34053,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -34338,7 +34338,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34349,7 +34349,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -34481,7 +34481,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34491,7 +34491,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -34566,7 +34566,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34577,7 +34577,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", @@ -34759,7 +34759,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "environment": "production", @@ -34776,7 +34776,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -34882,7 +34882,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34894,7 +34894,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -34966,12 +34966,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35007,13 +35007,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "repos": { "total_repos": 212, @@ -35096,12 +35096,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35128,12 +35128,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35160,12 +35160,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35192,12 +35192,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35224,12 +35224,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35256,12 +35256,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35288,12 +35288,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35320,12 +35320,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35352,12 +35352,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35384,12 +35384,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35418,13 +35418,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -35485,13 +35485,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -35522,12 +35522,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35575,13 +35575,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Global", @@ -35770,7 +35770,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -35788,7 +35788,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -35857,7 +35857,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -35866,7 +35866,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -36053,7 +36053,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "events": [ @@ -36070,7 +36070,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -36127,7 +36127,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -36135,7 +36135,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36174,7 +36174,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -36182,7 +36182,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36234,7 +36234,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" @@ -36246,7 +36246,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com", "id": 1, @@ -36300,7 +36300,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -36309,7 +36309,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "queued" } @@ -36360,7 +36360,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" @@ -36372,7 +36372,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com", "login": "octocat", @@ -36456,7 +36456,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -36465,7 +36465,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "queued" } @@ -36497,13 +36497,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "seats": 1400, "seats_used": 1316, @@ -36540,13 +36540,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "running", "progress": [ @@ -36598,12 +36598,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36630,13 +36630,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "scheduled", "scheduled_time": "Tuesday, January 22 at 15:34 -0800", @@ -36696,7 +36696,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "maintenance": "{\"enabled\":true, \"when\":\"now\"}" @@ -36705,7 +36705,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "scheduled", "scheduled_time": "Tuesday, January 22 at 15:34 -0800", @@ -36754,13 +36754,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enterprise": { "private_mode": false, @@ -36938,7 +36938,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "settings": "{ \"enterprise\": { \"public_pages\": true }}" @@ -36946,7 +36946,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36973,13 +36973,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -37031,7 +37031,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" @@ -37040,7 +37040,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -37092,7 +37092,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" @@ -37101,7 +37101,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -37171,12 +37171,12 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37214,12 +37214,12 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37305,7 +37305,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -37314,7 +37314,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 42, @@ -37371,7 +37371,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -37381,7 +37381,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -37456,7 +37456,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enforcement": "enabled", @@ -37470,7 +37470,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -37525,7 +37525,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -37535,7 +37535,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -37602,7 +37602,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "github", @@ -37613,7 +37613,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -37675,7 +37675,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "the-new-octocats" @@ -37687,7 +37687,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename organization. It may take a few minutes to complete.", "url": "https:///api/v3/organizations/1" @@ -37768,13 +37768,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -37857,7 +37857,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "DevTools Hook Env", @@ -37867,7 +37867,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -37922,7 +37922,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -37931,7 +37931,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -38006,7 +38006,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38015,7 +38015,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -38074,7 +38074,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38082,7 +38082,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38125,7 +38125,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38134,7 +38134,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "not_started", @@ -38183,7 +38183,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38192,7 +38192,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "success", @@ -38277,13 +38277,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -38403,7 +38403,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Check Commits", @@ -38421,7 +38421,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -38489,7 +38489,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" @@ -38498,7 +38498,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -38626,7 +38626,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Check Commits", @@ -38642,7 +38642,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -38710,7 +38710,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" @@ -38718,7 +38718,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38815,7 +38815,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38825,7 +38825,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 42, @@ -38890,7 +38890,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38901,7 +38901,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -38980,7 +38980,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enforcement": "enabled" @@ -38994,7 +38994,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -39057,7 +39057,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39068,7 +39068,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Responds with effective values inherited from owner and/or global level.", + "description": "

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

    ", "example": { "id": 42, "name": "Check Commits", @@ -39162,13 +39162,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -39231,7 +39231,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_ids": "KEY_IDS" @@ -39239,7 +39239,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39285,13 +39285,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -39362,7 +39362,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "token_id": "TOKEN_ID" @@ -39370,7 +39370,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39417,7 +39417,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "monalisa", @@ -39427,7 +39427,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -39495,7 +39495,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "thenewmonalisa" @@ -39507,7 +39507,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename user. It may take a few minutes to complete.", "url": "https://api.github.com/user/1" @@ -39548,7 +39548,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39556,7 +39556,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39607,7 +39607,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39616,7 +39616,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when getting an existing impersonation OAuth token", + "description": "

    Response when getting an existing impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -39644,7 +39644,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39653,7 +39653,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when creating a new impersonation OAuth token", + "description": "

    Response when creating a new impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -39715,7 +39715,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39723,7 +39723,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39760,7 +39760,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39768,7 +39768,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39805,7 +39805,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39813,7 +39813,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39861,7 +39861,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39869,7 +39869,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39917,7 +39917,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39925,7 +39925,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39984,13 +39984,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -40145,13 +40145,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -40238,13 +40238,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -40361,13 +40361,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -40465,7 +40465,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40474,7 +40474,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -40604,7 +40604,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40613,7 +40613,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -40673,7 +40673,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40681,7 +40681,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40748,7 +40748,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40757,7 +40757,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", @@ -40856,7 +40856,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40865,7 +40865,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -40962,7 +40962,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40971,7 +40971,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -41071,7 +41071,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41079,7 +41079,7 @@ }, "response": { "statusCode": "204", - "description": "Response if gist is starred" + "description": "

    Response if gist is starred

    " } } ], @@ -41128,7 +41128,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41136,7 +41136,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41185,7 +41185,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41193,7 +41193,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41251,7 +41251,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -41261,7 +41261,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -41353,7 +41353,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -41362,7 +41362,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -41473,7 +41473,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41482,7 +41482,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -41577,7 +41577,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41586,7 +41586,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -41673,7 +41673,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -41683,7 +41683,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -41785,7 +41785,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -41795,7 +41795,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -41874,7 +41874,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -41883,7 +41883,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41966,7 +41966,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "Content of the blob", @@ -41980,7 +41980,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" @@ -42055,7 +42055,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42066,7 +42066,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", "encoding": "base64", @@ -42329,7 +42329,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -42352,7 +42352,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -42450,7 +42450,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42461,7 +42461,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", @@ -42575,7 +42575,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42586,7 +42586,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/feature-a", @@ -42664,7 +42664,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42675,7 +42675,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -42766,7 +42766,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "refs/heads/featureA", @@ -42780,7 +42780,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -42871,7 +42871,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", @@ -42886,7 +42886,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -42956,7 +42956,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42966,7 +42966,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -43140,7 +43140,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag": "v0.0.1", @@ -43161,7 +43161,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -43243,7 +43243,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43254,7 +43254,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -43482,7 +43482,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -43503,7 +43503,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", @@ -43595,7 +43595,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43606,7 +43606,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -43642,7 +43642,7 @@ { "key": "response-recursively-retrieving-a-tree", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43653,7 +43653,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response recursively retrieving a tree", + "description": "

    Response recursively retrieving a tree

    ", "example": { "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", @@ -43706,13 +43706,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "Actionscript", "Android", @@ -43762,7 +43762,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "name": "NAME" @@ -43771,7 +43771,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" @@ -43946,13 +43946,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -44365,7 +44365,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -44374,7 +44374,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -44806,7 +44806,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44816,7 +44816,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -45147,7 +45147,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -45168,7 +45168,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -45400,7 +45400,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45411,7 +45411,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -45773,7 +45773,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -45796,7 +45796,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -46049,7 +46049,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46059,7 +46059,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46130,7 +46130,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46140,7 +46140,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46275,13 +46275,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -46621,7 +46621,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46631,7 +46631,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -46712,7 +46712,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46722,7 +46722,7 @@ }, "response": { "statusCode": "204", - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned." + "description": "

    If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

    " } } ], @@ -46795,7 +46795,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -46812,7 +46812,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -47038,7 +47038,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -47055,7 +47055,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -47315,7 +47315,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47325,7 +47325,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -47423,7 +47423,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47434,7 +47434,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -47538,7 +47538,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -47552,7 +47552,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -47642,7 +47642,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47652,7 +47652,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -47735,7 +47735,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47746,7 +47746,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -47855,7 +47855,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -47869,7 +47869,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -47982,7 +47982,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47992,7 +47992,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -48221,7 +48221,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48232,7 +48232,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", @@ -48525,7 +48525,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48536,7 +48536,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -48653,7 +48653,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48664,7 +48664,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -48758,7 +48758,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -48775,7 +48775,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -48873,7 +48873,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -48890,7 +48890,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -48973,7 +48973,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48983,7 +48983,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49051,7 +49051,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49063,7 +49063,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -49146,7 +49146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49156,7 +49156,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -49255,7 +49255,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "bug", @@ -49270,7 +49270,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -49342,7 +49342,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49353,7 +49353,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -49450,7 +49450,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "bug :bug:", @@ -49466,7 +49466,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -49530,7 +49530,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49540,7 +49540,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49613,7 +49613,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49624,7 +49624,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -49753,7 +49753,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49763,7 +49763,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", @@ -49896,7 +49896,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -49912,7 +49912,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -50012,7 +50012,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50023,7 +50023,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -50163,7 +50163,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -50180,7 +50180,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -50272,7 +50272,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50282,7 +50282,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50361,7 +50361,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50371,7 +50371,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50440,13 +50440,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "mit", @@ -50538,7 +50538,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "license": "LICENSE" @@ -50547,7 +50547,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "mit", "name": "MIT License", @@ -50630,7 +50630,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50640,7 +50640,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "LICENSE", "path": "LICENSE", @@ -50733,12 +50733,12 @@ "key": "200", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50797,12 +50797,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50829,13 +50829,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "verifiable_password_authentication": true, "packages": [ @@ -50886,12 +50886,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50918,12 +50918,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50974,7 +50974,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50984,7 +50984,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "description": "

    Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

    ", "example": [ [ 1302998400, @@ -51045,7 +51045,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51055,7 +51055,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "days": [ @@ -51124,7 +51124,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51134,7 +51134,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "
      \n
    • w - Start of the week, given as a Unix timestamp.
    • \n
    • a - Number of additions
    • \n
    • d - Number of deletions
    • \n
    • c - Number of commits
    • \n
    ", "example": [ { "author": { @@ -51221,7 +51221,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51231,7 +51231,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The array order is oldest week (index 0) to most recent week.", + "description": "

    The array order is oldest week (index 0) to most recent week.

    ", "example": { "all": [ 11, @@ -51391,7 +51391,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51401,7 +51401,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "description": "

    For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

    ", "example": [ [ 0, @@ -51480,13 +51480,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -51555,7 +51555,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -51564,7 +51564,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/applications/grants/1", @@ -51627,7 +51627,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -51635,7 +51635,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51702,13 +51702,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -51856,13 +51856,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52006,7 +52006,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -52015,7 +52015,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52043,7 +52043,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -52052,7 +52052,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.2/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.2/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "description": "

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

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52196,7 +52196,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -52206,7 +52206,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52234,7 +52234,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -52244,7 +52244,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response if returning a new token", + "description": "

    Response if returning a new token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52310,7 +52310,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -52319,7 +52319,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52464,7 +52464,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -52473,7 +52473,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52535,7 +52535,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -52543,7 +52543,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52605,13 +52605,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -52668,7 +52668,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52677,7 +52677,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "github", "id": 1, @@ -52943,7 +52943,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "billing_email": "mona@github.com", @@ -52964,7 +52964,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -53081,7 +53081,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -53090,7 +53090,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "installations": [ @@ -53192,13 +53192,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -53281,7 +53281,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -53290,7 +53290,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -53393,7 +53393,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -53402,7 +53402,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -53478,7 +53478,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53487,7 +53487,7 @@ }, "response": { "statusCode": "204", - "description": "Response if requester is an organization member and user is a member" + "description": "

    Response if requester is an organization member and user is a member

    " } } ], @@ -53541,7 +53541,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53550,7 +53550,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53600,7 +53600,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53610,7 +53610,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -53720,7 +53720,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53730,7 +53730,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -53824,7 +53824,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53833,7 +53833,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53896,7 +53896,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -53905,7 +53905,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -53973,7 +53973,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53982,7 +53982,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a public member" + "description": "

    Response if user is a public member

    " } } ], @@ -54032,7 +54032,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54041,7 +54041,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54091,7 +54091,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54100,7 +54100,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54159,13 +54159,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", @@ -54300,7 +54300,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -54309,7 +54309,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", @@ -54408,7 +54408,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "active" @@ -54420,7 +54420,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -54543,7 +54543,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -54552,7 +54552,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -54620,7 +54620,7 @@ { "key": "202", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54629,13 +54629,13 @@ }, "response": { "statusCode": "202", - "description": "User is getting converted asynchronously" + "description": "

    User is getting converted asynchronously

    " } }, { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54644,7 +54644,7 @@ }, "response": { "statusCode": "204", - "description": "User was converted" + "description": "

    User was converted

    " } } ], @@ -54702,7 +54702,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54711,7 +54711,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54772,7 +54772,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -54781,7 +54781,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -55057,7 +55057,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -55078,7 +55078,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -55151,7 +55151,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55161,7 +55161,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -55402,7 +55402,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -55418,7 +55418,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -55490,7 +55490,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55499,7 +55499,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -55549,7 +55549,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55559,7 +55559,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -55669,7 +55669,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55679,7 +55679,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -55749,7 +55749,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55759,7 +55759,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -55850,7 +55850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55861,7 +55861,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -55967,7 +55967,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55977,7 +55977,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -56031,7 +56031,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -56040,7 +56040,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56093,7 +56093,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56103,7 +56103,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -56244,7 +56244,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "source": { @@ -56260,7 +56260,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -56409,7 +56409,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "cname": "octocatblog.com", @@ -56425,7 +56425,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56479,7 +56479,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56488,7 +56488,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56562,7 +56562,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56572,7 +56572,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", @@ -56651,7 +56651,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56661,7 +56661,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", "status": "queued" @@ -56711,7 +56711,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56721,7 +56721,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -56807,7 +56807,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56818,7 +56818,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -56923,7 +56923,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -56932,7 +56932,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -57031,7 +57031,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Organization Roadmap", @@ -57044,7 +57044,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -57137,7 +57137,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -57146,7 +57146,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -57296,7 +57296,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -57305,7 +57305,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -57402,7 +57402,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -57410,7 +57410,7 @@ }, "response": { "statusCode": "204", - "description": "Delete Success" + "description": "

    Delete Success

    " } } ], @@ -57511,7 +57511,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57521,7 +57521,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", @@ -57645,7 +57645,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Projects Documentation", @@ -57659,7 +57659,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -57771,13 +57771,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", @@ -57903,7 +57903,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -57912,7 +57912,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/users/octocat", @@ -57994,7 +57994,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -58003,7 +58003,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -58119,7 +58119,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -58128,7 +58128,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -58219,7 +58219,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -58227,7 +58227,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58309,7 +58309,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -58317,7 +58317,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58409,7 +58409,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -58418,7 +58418,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/cards/1478", @@ -58544,7 +58544,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -58553,7 +58553,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -58679,7 +58679,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -58688,7 +58688,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -58798,7 +58798,7 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -58807,7 +58807,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58875,7 +58875,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -58884,7 +58884,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58952,7 +58952,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -58962,7 +58962,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "permission": "admin", "user": { @@ -59046,7 +59046,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59055,7 +59055,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -59134,7 +59134,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59143,7 +59143,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -59204,7 +59204,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59212,7 +59212,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59278,7 +59278,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59286,7 +59286,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59359,7 +59359,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -59368,7 +59368,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/367", @@ -59445,7 +59445,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -59454,7 +59454,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -59611,7 +59611,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -59621,7 +59621,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -60262,7 +60262,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Amazing new feature", @@ -60278,7 +60278,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -60874,7 +60874,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60885,7 +60885,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "

    Pass the appropriate media type to fetch diff and patch formats.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -61536,7 +61536,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "new title", @@ -61553,7 +61553,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -62167,7 +62167,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62178,7 +62178,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -62331,7 +62331,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62342,7 +62342,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", @@ -62419,7 +62419,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62429,7 +62429,7 @@ }, "response": { "statusCode": "204", - "description": "Response if pull request has been merged" + "description": "

    Response if pull request has been merged

    " } } ], @@ -62531,7 +62531,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62542,7 +62542,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if merge was successful", + "description": "

    if merge was successful

    ", "example": { "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "merged": true, @@ -62633,7 +62633,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" @@ -62647,7 +62647,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Updating pull request branch.", "url": "https://github.com/repos/octocat/Hello-World/pulls/53" @@ -62765,7 +62765,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62775,7 +62775,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -62891,7 +62891,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62902,7 +62902,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -63031,7 +63031,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "I like this too!" @@ -63045,7 +63045,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -63158,7 +63158,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63168,7 +63168,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63282,7 +63282,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63293,7 +63293,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -63434,6 +63434,10 @@ { "type": "integer", "description": "

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + }, "name": "position", "in": "body", "rawType": "integer", @@ -63504,7 +63508,7 @@ "key": "example-for-a-multi-line-comment", "request": { "contentType": "application/json", - "description": "Example for a multi-line comment", + "description": "

    Example for a multi-line comment

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!", @@ -63524,7 +63528,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -63665,7 +63669,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!" @@ -63680,7 +63684,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -63815,7 +63819,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63826,7 +63830,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "users": [ { @@ -63947,7 +63951,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -63968,7 +63972,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -64615,7 +64619,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -64635,7 +64639,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64714,7 +64718,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64725,7 +64729,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The list of reviews returns in chronological order.", + "description": "

    The list of reviews returns in chronological order.

    ", "example": [ { "id": 80, @@ -65023,7 +65027,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", @@ -65046,7 +65050,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65157,7 +65161,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65169,7 +65173,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65287,7 +65291,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is close to perfect! Please address the suggested inline change. And add more about this." @@ -65302,7 +65306,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65409,7 +65413,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65421,7 +65425,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65550,7 +65554,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65562,7 +65566,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -65704,7 +65708,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65716,7 +65720,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65852,7 +65856,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65864,7 +65868,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65945,13 +65949,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "resources": { "core": { @@ -66104,7 +66108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66116,7 +66120,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -66231,7 +66235,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66246,7 +66250,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "

    Response when the reaction type has already been added to this team discussion comment

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66279,7 +66283,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66294,7 +66298,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66399,7 +66403,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66411,7 +66415,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66505,7 +66509,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66516,7 +66520,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -66622,7 +66626,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66636,7 +66640,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66669,7 +66673,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66683,7 +66687,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66779,7 +66783,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66790,7 +66794,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66829,7 +66833,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "reaction_id": "REACTION_ID" @@ -66837,7 +66841,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66947,7 +66951,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66958,7 +66962,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67068,7 +67072,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67082,7 +67086,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67115,7 +67119,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67129,7 +67133,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67233,7 +67237,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67244,7 +67248,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67338,7 +67342,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67349,7 +67353,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67459,7 +67463,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67473,7 +67477,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67506,7 +67510,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67520,7 +67524,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67620,7 +67624,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67631,7 +67635,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67725,7 +67729,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67736,7 +67740,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67850,7 +67854,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67864,7 +67868,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67897,7 +67901,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67911,7 +67915,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68011,7 +68015,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68022,7 +68026,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68116,7 +68120,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68127,7 +68131,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -68237,7 +68241,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -68251,7 +68255,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68284,7 +68288,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -68298,7 +68302,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68398,7 +68402,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68409,7 +68413,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68501,7 +68505,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68512,7 +68516,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -68624,7 +68628,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -68638,7 +68642,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68671,7 +68675,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -68685,7 +68689,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68785,7 +68789,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68796,7 +68800,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68890,7 +68894,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -68901,7 +68905,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -69007,7 +69011,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -69021,7 +69025,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -69132,7 +69136,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -69142,7 +69146,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -69239,7 +69243,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -69252,7 +69256,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -69304,6 +69308,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69348,7 +69353,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69358,7 +69363,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", @@ -69449,8 +69454,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69458,6 +69462,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69542,7 +69547,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -69560,7 +69565,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -69650,8 +69655,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69659,6 +69663,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69685,7 +69690,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69695,7 +69700,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -69781,8 +69786,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69790,6 +69794,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69826,7 +69831,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69837,7 +69842,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -69927,8 +69932,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69936,6 +69940,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69971,7 +69976,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69982,7 +69987,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#hypermedia).", + "description": "

    Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -70072,8 +70077,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70081,6 +70085,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70172,7 +70177,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -70191,7 +70196,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -70277,8 +70282,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70286,6 +70290,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70321,7 +70326,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70331,7 +70336,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70342,8 +70347,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ @@ -70389,7 +70393,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70400,7 +70404,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "

    To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -70528,7 +70532,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "foo-1.0.0-osx.zip", @@ -70543,7 +70547,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -70632,7 +70636,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70642,7 +70646,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70715,7 +70719,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70726,7 +70730,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", @@ -70835,7 +70839,7 @@ "key": "default", "request": { "contentType": "*/*", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70846,7 +70850,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for successful upload", + "description": "

    Response for successful upload

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -70989,7 +70993,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -70998,7 +71002,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -71324,7 +71328,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -71342,7 +71346,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -71520,7 +71524,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71530,7 +71534,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -72043,7 +72047,7 @@ { "key": "response-with-scarlet-witch-preview-media-type", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72053,7 +72057,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with scarlet-witch-preview media type", + "description": "

    Response with scarlet-witch-preview media type

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -73091,7 +73095,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -73110,7 +73114,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -73681,7 +73685,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73690,7 +73694,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73775,7 +73779,7 @@ { "key": "response-if-repository-contains-content", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73785,7 +73789,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if repository contains content", + "description": "

    if repository contains content

    ", "example": [ { "login": "octocat", @@ -73890,7 +73894,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "event_type": "on-demand-test", @@ -73906,7 +73910,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73956,7 +73960,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73966,7 +73970,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "C": 78769, "Python": 7769 @@ -74034,7 +74038,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74044,7 +74048,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "v0.1", @@ -74120,7 +74124,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74130,7 +74134,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -74210,7 +74214,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74220,7 +74224,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -74298,7 +74302,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "names": [ @@ -74316,7 +74320,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -74407,7 +74411,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_owner": "github", @@ -74424,7 +74428,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -74745,7 +74749,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "owner": "octocat", @@ -74762,7 +74766,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -74934,13 +74938,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -75156,13 +75160,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -75545,13 +75549,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -75798,7 +75802,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -75807,7 +75811,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -75983,7 +75987,7 @@ { "key": "response-if-content-is-a-file", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -75994,7 +75998,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a file", + "description": "

    Response if content is a file

    ", "example": { "type": "file", "encoding": "base64", @@ -76018,7 +76022,7 @@ { "key": "response-if-content-is-a-directory", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76029,7 +76033,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a directory", + "description": "

    Response if content is a directory

    ", "example": [ { "type": "file", @@ -76069,7 +76073,7 @@ { "key": "response-if-content-is-a-symlink", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76080,7 +76084,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a symlink", + "description": "

    Response if content is a symlink

    ", "example": { "type": "symlink", "target": "/path/to/symlink/target", @@ -76103,7 +76107,7 @@ { "key": "response-if-content-is-a-submodule", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76114,7 +76118,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a submodule", + "description": "

    Response if content is a submodule

    ", "example": { "type": "submodule", "submodule_git_url": "git://github.com/jquery/qunit.git", @@ -76399,7 +76403,7 @@ "key": "example-for-creating-a-file", "request": { "contentType": "application/json", - "description": "Example for creating a file", + "description": "

    Example for creating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -76418,7 +76422,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -76477,7 +76481,7 @@ "key": "example-for-updating-a-file", "request": { "contentType": "application/json", - "description": "Example for updating a file", + "description": "

    Example for updating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "a new commit message", @@ -76497,7 +76501,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -76760,7 +76764,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -76779,7 +76783,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": null, "commit": { @@ -76887,7 +76891,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76897,7 +76901,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -76988,7 +76992,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76999,7 +77003,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -77080,7 +77084,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77090,7 +77094,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77145,7 +77149,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77155,7 +77159,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77237,7 +77241,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77247,7 +77251,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -77424,7 +77428,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77434,7 +77438,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -78043,13 +78047,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 7, "incomplete_results": false, @@ -78229,13 +78233,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "incomplete_results": false, @@ -78460,13 +78464,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 280, "incomplete_results": false, @@ -78673,13 +78677,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "incomplete_results": false, @@ -78805,13 +78809,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 40, "incomplete_results": false, @@ -78990,13 +78994,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 6, "incomplete_results": false, @@ -79173,13 +79177,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 12, "incomplete_results": false, @@ -79317,7 +79321,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -79327,7 +79331,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -79437,7 +79441,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -79448,7 +79452,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -79561,7 +79565,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "resolved", @@ -79576,7 +79580,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -79679,7 +79683,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -79688,7 +79692,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -79834,7 +79838,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Justice League", @@ -79849,7 +79853,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -79950,7 +79954,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -79960,7 +79964,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -80117,7 +80121,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -80132,7 +80136,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -80225,7 +80229,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80234,7 +80238,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80298,7 +80302,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80308,7 +80312,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -80408,7 +80412,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80419,7 +80423,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -80537,7 +80541,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80547,7 +80551,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80608,7 +80612,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80618,7 +80622,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80682,7 +80686,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80692,7 +80696,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -80862,7 +80866,7 @@ { "key": "alternative-response-with-repository-permissions", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80874,7 +80878,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with repository permissions", + "description": "

    Alternative response with repository permissions

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -81212,7 +81216,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81223,7 +81227,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81287,7 +81291,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81298,7 +81302,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81362,7 +81366,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81372,7 +81376,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -81437,7 +81441,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -81446,7 +81450,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -81594,7 +81598,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -81608,7 +81612,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the updated information already exists", + "description": "

    Response when the updated information already exists

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -81662,7 +81666,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -81676,7 +81680,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -81776,7 +81780,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -81784,7 +81788,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81847,7 +81851,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -81856,7 +81860,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -81951,7 +81955,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81961,7 +81965,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -82070,7 +82074,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -82079,7 +82083,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82139,7 +82143,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -82148,7 +82152,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82211,7 +82215,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -82220,7 +82224,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -82385,7 +82389,7 @@ { "key": "alternative-response-with-extra-repository-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -82396,7 +82400,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with extra repository information", + "description": "

    Alternative response with extra repository information

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -82722,7 +82726,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -82732,7 +82736,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82795,7 +82799,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -82805,7 +82809,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82860,7 +82864,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -82869,7 +82873,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -82955,13 +82959,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -83112,7 +83116,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -83123,7 +83127,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -83238,7 +83242,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -83252,7 +83256,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -83363,7 +83367,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -83375,7 +83379,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -83497,7 +83501,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -83512,7 +83516,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -83623,7 +83627,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -83634,7 +83638,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83712,7 +83716,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83722,7 +83726,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -83828,7 +83832,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -83841,7 +83845,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -83943,7 +83947,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83954,7 +83958,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84067,7 +84071,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -84081,7 +84085,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84183,7 +84187,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -84193,7 +84197,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84282,7 +84286,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -84292,7 +84296,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -84422,7 +84426,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -84436,7 +84440,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84543,7 +84547,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -84554,7 +84558,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84681,7 +84685,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -84695,7 +84699,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84802,7 +84806,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -84812,7 +84816,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84881,7 +84885,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -84890,7 +84894,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -85011,7 +85015,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -85024,7 +85028,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -85122,7 +85126,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -85132,7 +85136,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -85250,7 +85254,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -85263,7 +85267,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -85361,7 +85365,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -85370,7 +85374,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85451,7 +85455,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -85461,7 +85465,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -85538,7 +85542,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -85549,7 +85553,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -85629,7 +85633,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -85640,7 +85644,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -85708,7 +85712,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -85718,7 +85722,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85792,7 +85796,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -85801,7 +85805,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -85873,7 +85877,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -85882,7 +85886,7 @@ }, "response": { "statusCode": "204", - "description": "if user is a member" + "description": "

    if user is a member

    " } } ], @@ -85932,7 +85936,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -85941,7 +85945,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85999,7 +86003,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -86008,7 +86012,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -86058,7 +86062,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -86068,7 +86072,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -86139,7 +86143,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -86149,7 +86153,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -86212,7 +86216,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -86221,7 +86225,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -86255,13 +86259,13 @@ { "key": "response-with-public-and-private-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public and private profile information", + "description": "

    Response with public and private profile information

    ", "example": { "login": "octocat", "id": 1, @@ -86312,13 +86316,13 @@ { "key": "response-with-public-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public profile information", + "description": "

    Response with public profile information

    ", "example": { "login": "octocat", "id": 1, @@ -86485,13 +86489,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -86602,13 +86606,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -86671,7 +86675,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -86680,7 +86684,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "octocat", "id": 1, @@ -86720,7 +86724,7 @@ { "key": "response-with-git-hub-plan-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -86729,7 +86733,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with GitHub plan information", + "description": "

    Response with GitHub plan information

    ", "example": { "login": "octocat", "id": 1, @@ -86834,7 +86838,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -86843,7 +86847,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "contexts": [ { @@ -86908,13 +86912,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -86984,13 +86988,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@octocat.org", @@ -87075,12 +87079,12 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87146,13 +87150,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -87224,13 +87228,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -87310,13 +87314,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -87387,7 +87391,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -87395,7 +87399,7 @@ }, "response": { "statusCode": "204", - "description": "if the person is followed by the authenticated user" + "description": "

    if the person is followed by the authenticated user

    " } } ], @@ -87448,7 +87452,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -87456,7 +87460,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87509,7 +87513,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -87517,7 +87521,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87588,7 +87592,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -87597,7 +87601,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -87674,7 +87678,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -87683,7 +87687,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -87751,7 +87755,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -87760,7 +87764,7 @@ }, "response": { "statusCode": "204", - "description": "if the user follows the target user" + "description": "

    if the user follows the target user

    " } } ], @@ -87812,13 +87816,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -87909,13 +87913,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -88007,7 +88011,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -88016,7 +88020,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -88104,7 +88108,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -88112,7 +88116,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88187,7 +88191,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -88196,7 +88200,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -88281,13 +88285,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -88374,13 +88378,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -88446,7 +88450,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -88455,7 +88459,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -88517,7 +88521,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -88525,7 +88529,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88596,7 +88600,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -88605,7 +88609,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -88670,7 +88674,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -88681,7 +88685,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -88800,7 +88804,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -88811,7 +88815,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -88892,7 +88896,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -88903,7 +88907,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -89003,7 +89007,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -89015,7 +89019,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -89130,7 +89134,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -89141,7 +89145,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -89215,7 +89219,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -89225,7 +89229,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Repository", @@ -89514,7 +89518,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -89537,7 +89541,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -89630,7 +89634,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -89641,7 +89645,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -89955,7 +89959,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -89972,7 +89976,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -90061,7 +90065,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90071,7 +90075,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -90130,7 +90134,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90140,7 +90144,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -90199,7 +90203,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90209,7 +90213,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 6fa2dd76d7..6ed4abc299 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -52,7 +52,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62,7 +62,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -146,7 +146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -157,7 +157,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 11, "node_id": "MDg6QXJ0aWZhY3QxMQ==", @@ -224,7 +224,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -234,7 +234,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -298,7 +298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -309,7 +309,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -382,7 +382,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -393,7 +393,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -461,7 +461,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -470,7 +470,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_organizations": "all", "allowed_actions": "selected", @@ -542,7 +542,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_organizations": "all", @@ -554,7 +554,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -609,7 +609,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -618,7 +618,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -689,7 +689,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -703,7 +703,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -749,7 +749,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -758,7 +758,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -804,7 +804,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -813,7 +813,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -850,7 +850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -859,7 +859,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -927,7 +927,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -943,7 +943,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -980,7 +980,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -989,7 +989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_repositories": "all", "allowed_actions": "selected", @@ -1061,7 +1061,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_repositories": "all", @@ -1073,7 +1073,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1128,7 +1128,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1137,7 +1137,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -1317,7 +1317,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -1331,7 +1331,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1377,7 +1377,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1386,7 +1386,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1432,7 +1432,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1441,7 +1441,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1478,7 +1478,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1487,7 +1487,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1555,7 +1555,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1571,7 +1571,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1617,7 +1617,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1627,7 +1627,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled": true, "allowed_actions": "selected", @@ -1703,7 +1703,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled": true, @@ -1716,7 +1716,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1762,7 +1762,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1772,7 +1772,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1849,7 +1849,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1866,7 +1866,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1923,7 +1923,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1932,7 +1932,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "secrets": [ @@ -1993,7 +1993,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -2002,7 +2002,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2052,7 +2052,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2062,7 +2062,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2162,7 +2162,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2180,14 +2180,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2205,7 +2205,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -2255,7 +2255,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2264,7 +2264,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2328,7 +2328,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2338,7 +2338,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -2472,7 +2472,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -2486,7 +2486,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2541,7 +2541,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2551,7 +2551,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -2610,7 +2610,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2620,7 +2620,7 @@ }, "response": { "statusCode": "204", - "description": "Response when repository was removed from the selected list" + "description": "

    Response when repository was removed from the selected list

    " } } ], @@ -2688,7 +2688,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2698,7 +2698,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -2759,7 +2759,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2769,7 +2769,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2828,7 +2828,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2839,7 +2839,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2920,7 +2920,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2934,14 +2934,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2955,7 +2955,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3014,7 +3014,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3024,7 +3024,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3088,7 +3088,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3098,7 +3098,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -3159,7 +3159,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3169,7 +3169,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -3228,7 +3228,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3239,7 +3239,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -3320,7 +3320,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3334,14 +3334,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3355,7 +3355,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3414,7 +3414,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3424,7 +3424,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -3481,7 +3481,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -3490,7 +3490,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -3617,7 +3617,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3638,7 +3638,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3693,7 +3693,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3703,7 +3703,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3793,7 +3793,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3807,7 +3807,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "Expensive hardware runners", @@ -3862,7 +3862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3871,7 +3871,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3935,7 +3935,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3945,7 +3945,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -4025,7 +4025,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -4040,7 +4040,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4095,7 +4095,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4105,7 +4105,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4160,7 +4160,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4170,7 +4170,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4234,7 +4234,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4244,7 +4244,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -4363,7 +4363,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -4378,7 +4378,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4433,7 +4433,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4443,7 +4443,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4498,7 +4498,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4508,7 +4508,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4563,7 +4563,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -4572,7 +4572,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -4704,7 +4704,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4725,7 +4725,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4781,7 +4781,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4791,7 +4791,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4882,7 +4882,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4896,7 +4896,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4952,7 +4952,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4961,7 +4961,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5025,7 +5025,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5035,7 +5035,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -5342,7 +5342,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -5357,7 +5357,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5412,7 +5412,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5422,7 +5422,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5477,7 +5477,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5487,7 +5487,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5551,7 +5551,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5561,7 +5561,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5680,7 +5680,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -5695,7 +5695,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5750,7 +5750,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5760,7 +5760,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5815,7 +5815,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5825,7 +5825,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5882,7 +5882,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5891,7 +5891,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5986,7 +5986,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5995,7 +5995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -6074,7 +6074,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6083,7 +6083,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -6124,7 +6124,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6133,7 +6133,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -6183,7 +6183,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6193,7 +6193,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -6268,7 +6268,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6277,7 +6277,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6332,7 +6332,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6341,7 +6341,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6436,7 +6436,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6445,7 +6445,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -6524,7 +6524,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6533,7 +6533,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -6574,7 +6574,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6583,7 +6583,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -6633,7 +6633,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6643,7 +6643,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -6718,7 +6718,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -6727,7 +6727,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6791,7 +6791,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6801,7 +6801,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6905,7 +6905,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6915,7 +6915,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -7003,7 +7003,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7013,7 +7013,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -7063,7 +7063,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7073,7 +7073,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -7132,7 +7132,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7143,7 +7143,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -7227,7 +7227,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7237,7 +7237,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7294,7 +7294,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7305,7 +7305,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 399444496, "run_id": 29679449, @@ -7466,7 +7466,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7476,7 +7476,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7563,7 +7563,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7574,7 +7574,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "jobs": [ @@ -7822,7 +7822,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7832,7 +7832,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -8078,7 +8078,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8089,7 +8089,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 30433642, "name": "Build", @@ -8319,7 +8319,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8329,7 +8329,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8384,7 +8384,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8395,7 +8395,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "state": "approved", @@ -8487,7 +8487,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8497,7 +8497,7 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8556,7 +8556,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8566,7 +8566,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8621,7 +8621,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8631,7 +8631,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8694,7 +8694,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8705,7 +8705,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "environment": { @@ -8865,7 +8865,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8876,7 +8876,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -8971,7 +8971,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8981,7 +8981,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9132,7 +9132,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9143,7 +9143,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -9390,7 +9390,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9400,7 +9400,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "workflows": [ @@ -9491,7 +9491,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9502,7 +9502,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", @@ -9576,7 +9576,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9586,7 +9586,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9672,7 +9672,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -9689,7 +9689,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9751,7 +9751,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9761,7 +9761,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9811,12 +9811,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9892,7 +9892,7 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9901,7 +9901,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9972,7 +9972,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -9980,7 +9980,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10044,7 +10044,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10053,7 +10053,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10108,7 +10108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10116,7 +10116,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10180,7 +10180,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -10189,7 +10189,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10244,7 +10244,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10252,7 +10252,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10307,7 +10307,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10315,7 +10315,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10370,7 +10370,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10378,7 +10378,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10407,13 +10407,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", @@ -10545,13 +10545,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -10701,24 +10701,24 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -10771,7 +10771,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10780,7 +10780,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": "1", "repository": { @@ -10913,7 +10913,7 @@ { "key": "205", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10921,7 +10921,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -10966,7 +10966,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -10975,7 +10975,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -11044,7 +11044,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -11053,7 +11053,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -11110,7 +11110,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -11118,7 +11118,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11234,7 +11234,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11244,7 +11244,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -11388,7 +11388,7 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11397,14 +11397,14 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11413,7 +11413,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -11483,7 +11483,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11493,7 +11493,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "login": "octocat", @@ -11521,7 +11521,7 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11531,7 +11531,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -11634,13 +11634,13 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -11771,13 +11771,13 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/vnd.github.v3.star+json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -11963,7 +11963,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11972,7 +11972,7 @@ }, "response": { "statusCode": "204", - "description": "Response if this repository is starred by you" + "description": "

    Response if this repository is starred by you

    " } } ], @@ -12034,7 +12034,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12043,7 +12043,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12105,7 +12105,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12114,7 +12114,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12213,7 +12213,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -12222,7 +12222,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -12413,7 +12413,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12423,7 +12423,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -12491,7 +12491,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12501,7 +12501,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if you subscribe to the repository", + "description": "

    if you subscribe to the repository

    ", "example": { "subscribed": true, "ignored": false, @@ -12583,7 +12583,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12593,7 +12593,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -12647,7 +12647,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12656,7 +12656,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12702,13 +12702,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -12881,7 +12881,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -12890,7 +12890,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -13026,13 +13026,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -13110,7 +13110,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "code": "CODE" @@ -13119,7 +13119,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -13237,13 +13237,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "The permissions the installation has are included under the `permissions` key.", + "description": "

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

    ", "example": [ { "id": 1, @@ -13337,7 +13337,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -13346,7 +13346,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -13442,7 +13442,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -13450,7 +13450,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14360,7 +14360,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "respoitory": "Hello-World", @@ -14376,7 +14376,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", @@ -14568,7 +14568,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -14576,7 +14576,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14622,7 +14622,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -14630,7 +14630,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14671,7 +14671,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "app_slug": "APP_SLUG" @@ -14680,7 +14680,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -14766,7 +14766,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -14775,7 +14775,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -14871,7 +14871,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14881,7 +14881,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -14976,7 +14976,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -14985,7 +14985,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -15084,13 +15084,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -15252,12 +15252,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15340,7 +15340,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15351,7 +15351,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 101, "title": "[A-1234] Error found in core/models.py file'", @@ -15428,13 +15428,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "You can find the permissions for the installation under the `permissions` key.", + "description": "

    You can find the permissions for the installation under the permissions key.

    ", "example": { "total_count": 2, "installations": [ @@ -15611,7 +15611,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -15620,7 +15620,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "description": "

    The access the user has to each repository is included in the hash under the permissions key.

    ", "example": { "total_count": 1, "repositories": [ @@ -15811,7 +15811,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -15820,7 +15820,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15883,7 +15883,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -15892,7 +15892,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15959,7 +15959,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -15970,7 +15970,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16025,7 +16025,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -16034,7 +16034,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16087,7 +16087,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -16099,7 +16099,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -16202,7 +16202,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -16214,7 +16214,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -16313,7 +16313,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -16324,7 +16324,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17270,7 +17270,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", @@ -17288,7 +17288,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -17426,7 +17426,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -17436,7 +17436,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -17533,7 +17533,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -17543,7 +17543,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -17636,7 +17636,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -17645,7 +17645,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17674,13 +17674,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -17771,7 +17771,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content_type": "json", @@ -17783,7 +17783,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -17835,13 +17835,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -17914,7 +17914,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -17923,7 +17923,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -18011,7 +18011,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -18019,7 +18019,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -18050,6 +18050,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18103,7 +18104,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18113,7 +18114,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "master", @@ -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", @@ -18193,7 +18194,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18203,7 +18204,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -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", @@ -18278,7 +18279,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "my_renamed_branch" @@ -18292,7 +18293,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "master", "commit": { @@ -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", @@ -18461,7 +18462,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "branch": "main" @@ -18474,7 +18475,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The branch has been successfully synced with the upstream repository", + "description": "

    The branch has been successfully synced with the upstream repository

    ", "example": { "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", "merge_type": "fast-forward", @@ -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", @@ -18562,7 +18563,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base": "master", @@ -18577,7 +18578,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Successful Response (The resulting merge commit)", + "description": "

    Successful Response (The resulting merge commit)

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -18703,8 +18704,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -18751,7 +18751,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18762,7 +18762,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", "required_status_checks": { @@ -19609,7 +19609,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "required_status_checks": { @@ -19665,7 +19665,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19733,7 +19733,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19743,7 +19743,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -19803,7 +19803,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19814,7 +19814,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -19874,7 +19874,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19885,7 +19885,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -19945,7 +19945,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19955,7 +19955,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20015,7 +20015,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20026,7 +20026,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -20227,7 +20227,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "dismissal_restrictions": { @@ -20259,7 +20259,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -20368,7 +20368,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20378,7 +20378,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20438,7 +20438,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20449,7 +20449,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -20513,7 +20513,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20524,7 +20524,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -20588,7 +20588,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20598,7 +20598,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20658,7 +20658,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20669,7 +20669,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -20761,7 +20761,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "strict": true, @@ -20778,7 +20778,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -20850,7 +20850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20860,7 +20860,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20916,7 +20916,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20927,7 +20927,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -21004,7 +21004,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21015,7 +21015,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci", "continuous-integration/jenkins" @@ -21101,7 +21101,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21112,7 +21112,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -21193,7 +21193,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21204,7 +21204,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -21271,7 +21271,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21282,7 +21282,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", @@ -21423,7 +21423,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21433,7 +21433,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -21489,7 +21489,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21500,7 +21500,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21617,7 +21617,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21628,7 +21628,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21745,7 +21745,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21756,7 +21756,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21873,7 +21873,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21884,7 +21884,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -21987,7 +21987,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21998,7 +21998,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -22088,7 +22088,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22099,7 +22099,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -22189,7 +22189,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22200,7 +22200,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -22290,7 +22290,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22301,7 +22301,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -22377,7 +22377,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22388,7 +22388,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -22484,7 +22484,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22495,7 +22495,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -22591,7 +22591,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22602,7 +22602,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -22698,7 +22698,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22709,7 +22709,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -23737,7 +23737,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Example of an in_progress conclusion", + "description": "

    Example of an in_progress conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -23759,7 +23759,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "

    Response for in_progress conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -23856,7 +23856,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Example of a completed conclusion", + "description": "

    Example of a completed conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -23912,7 +23912,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "

    Response for completed conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -24057,7 +24057,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24068,7 +24068,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25154,7 +25154,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -25203,7 +25203,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25366,7 +25366,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25377,7 +25377,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "path": "README.md", @@ -25446,7 +25446,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25456,7 +25456,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -25580,7 +25580,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25591,7 +25591,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -25806,7 +25806,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25817,7 +25817,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -25971,7 +25971,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -25984,7 +25984,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the suite already exists", + "description": "

    Response when the suite already exists

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -26291,7 +26291,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -26304,7 +26304,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the suite was created", + "description": "

    Response when the suite was created

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -26720,7 +26720,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "auto_trigger_checks": [ @@ -26738,7 +26738,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "preferences": { "auto_trigger_checks": [ @@ -27032,7 +27032,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27043,7 +27043,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -27398,7 +27398,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27408,7 +27408,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -27501,7 +27501,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27512,7 +27512,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_suites": [ @@ -27811,7 +27811,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27821,7 +27821,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 4, @@ -27993,7 +27993,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28004,7 +28004,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-06-19T11:21:34Z", @@ -28174,7 +28174,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", @@ -28190,7 +28190,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-08-25T21:28:36Z", @@ -28355,7 +28355,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28366,7 +28366,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -28531,7 +28531,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28541,7 +28541,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -28652,7 +28652,7 @@ { "key": "response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28663,7 +28663,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "ref": "refs/heads/main", "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", @@ -28763,7 +28763,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28774,7 +28774,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" @@ -28904,7 +28904,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28914,7 +28914,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -28993,7 +28993,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29004,7 +29004,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "processing_status": "complete", "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -29051,13 +29051,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "citizen_code_of_conduct", @@ -29112,7 +29112,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key": "KEY" @@ -29121,7 +29121,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "contributor_covenant", "name": "Contributor Covenant", @@ -29160,6 +29160,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29219,7 +29220,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29229,7 +29230,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -29271,8 +29272,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29280,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", @@ -29315,7 +29316,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29325,7 +29326,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a collaborator" + "description": "

    Response if user is a collaborator

    " } } ], @@ -29340,8 +29341,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29349,6 +29349,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29414,7 +29415,7 @@ "key": "response-when-a-new-invitation-is-created", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29425,7 +29426,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when a new invitation is created", + "description": "

    Response when a new invitation is created

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -29565,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", @@ -29574,6 +29574,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29609,7 +29610,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29619,7 +29620,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -29630,8 +29631,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29639,6 +29639,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29674,7 +29675,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29685,7 +29686,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if user has admin permissions", + "description": "

    if user has admin permissions

    ", "example": { "permission": "admin", "user": { @@ -29723,8 +29724,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -29779,7 +29779,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29789,7 +29789,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -29981,7 +29981,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29992,7 +29992,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -30165,7 +30165,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30175,7 +30175,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -30221,13 +30221,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -30399,7 +30399,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -30407,7 +30407,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -30460,7 +30460,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -30468,7 +30468,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -30507,6 +30507,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30598,7 +30599,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30608,7 +30609,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -30715,8 +30716,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30724,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", @@ -30760,7 +30761,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30771,7 +30772,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "branch_5", @@ -30796,8 +30797,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30805,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", @@ -30859,7 +30860,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30870,7 +30871,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -31401,8 +31402,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31410,6 +31410,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31464,7 +31465,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31475,7 +31476,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -31593,8 +31594,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31602,6 +31602,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31655,7 +31656,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31666,7 +31667,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", @@ -31946,8 +31947,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -32002,7 +32002,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32012,7 +32012,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -32103,7 +32103,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32114,7 +32114,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -32218,7 +32218,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Nice change" @@ -32232,7 +32232,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -32325,7 +32325,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32335,7 +32335,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32413,7 +32413,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32424,7 +32424,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -32554,7 +32554,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff", @@ -32571,7 +32571,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -32689,7 +32689,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32700,7 +32700,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "state": "success", "statuses": [ @@ -32880,7 +32880,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32891,7 +32891,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -33030,7 +33030,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "success", @@ -33047,7 +33047,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", @@ -33094,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", @@ -33147,7 +33146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33157,7 +33156,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -33179,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", @@ -33243,7 +33242,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "octocat@octomac", @@ -33258,7 +33257,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -33282,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", @@ -33326,7 +33325,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33337,7 +33336,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -33361,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", @@ -33405,7 +33404,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33415,7 +33414,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33426,7 +33425,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -33438,6 +33438,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33525,7 +33526,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33535,7 +33536,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -33586,8 +33587,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33595,6 +33595,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33724,7 +33725,7 @@ "key": "simple-example", "request": { "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -33739,7 +33740,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -33800,8 +33801,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33809,6 +33809,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33844,7 +33845,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33855,7 +33856,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -33908,8 +33909,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33917,6 +33917,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33952,7 +33953,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33962,7 +33963,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33981,8 +33982,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -34037,7 +34037,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34047,7 +34047,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "environments": [ @@ -34180,7 +34180,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34191,7 +34191,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -34476,7 +34476,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34487,7 +34487,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -34619,7 +34619,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34629,7 +34629,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -34704,7 +34704,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34715,7 +34715,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", @@ -34894,7 +34894,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "environment": "production", @@ -34911,7 +34911,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -35014,7 +35014,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -35026,7 +35026,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -35095,12 +35095,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35136,13 +35136,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "repos": { "total_repos": 212, @@ -35225,12 +35225,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35257,12 +35257,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35289,12 +35289,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35321,12 +35321,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35353,12 +35353,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35385,12 +35385,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35417,12 +35417,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35449,12 +35449,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35481,12 +35481,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35513,12 +35513,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35547,13 +35547,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -35614,13 +35614,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -35651,12 +35651,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35753,7 +35753,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -35762,7 +35762,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "actor_ip": "88.123.45.123", @@ -35945,13 +35945,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Global", @@ -36127,7 +36127,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -36145,7 +36145,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -36202,7 +36202,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -36211,7 +36211,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -36386,7 +36386,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "events": [ @@ -36403,7 +36403,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -36458,7 +36458,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -36466,7 +36466,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36503,7 +36503,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -36511,7 +36511,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36561,7 +36561,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" @@ -36573,7 +36573,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com", "id": 1, @@ -36625,7 +36625,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -36634,7 +36634,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "queued" } @@ -36685,7 +36685,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" @@ -36697,7 +36697,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com", "login": "octocat", @@ -36781,7 +36781,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -36790,7 +36790,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "queued" } @@ -36822,13 +36822,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "seats": 1400, "seats_used": 1316, @@ -36865,13 +36865,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "running", "progress": [ @@ -36923,12 +36923,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36955,13 +36955,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "scheduled", "scheduled_time": "Tuesday, January 22 at 15:34 -0800", @@ -37021,7 +37021,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "maintenance": "{\"enabled\":true, \"when\":\"now\"}" @@ -37030,7 +37030,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "scheduled", "scheduled_time": "Tuesday, January 22 at 15:34 -0800", @@ -37079,13 +37079,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enterprise": { "private_mode": false, @@ -37263,7 +37263,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "settings": "{ \"enterprise\": { \"public_pages\": true }}" @@ -37271,7 +37271,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37298,13 +37298,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -37356,7 +37356,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" @@ -37365,7 +37365,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -37417,7 +37417,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" @@ -37426,7 +37426,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -37496,12 +37496,12 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37539,12 +37539,12 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37630,7 +37630,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -37639,7 +37639,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 42, @@ -37694,7 +37694,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -37704,7 +37704,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -37777,7 +37777,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enforcement": "enabled", @@ -37791,7 +37791,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -37844,7 +37844,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -37854,7 +37854,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -37919,7 +37919,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "github", @@ -37930,7 +37930,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -37992,7 +37992,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "the-new-octocats" @@ -38004,7 +38004,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename organization. It may take a few minutes to complete.", "url": "https:///api/v3/organizations/1" @@ -38085,13 +38085,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -38172,7 +38172,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "DevTools Hook Env", @@ -38182,7 +38182,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -38235,7 +38235,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38244,7 +38244,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -38317,7 +38317,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38326,7 +38326,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -38383,7 +38383,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38391,7 +38391,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38432,7 +38432,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38441,7 +38441,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "not_started", @@ -38488,7 +38488,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -38497,7 +38497,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "success", @@ -38580,13 +38580,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -38704,7 +38704,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Check Commits", @@ -38722,7 +38722,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -38788,7 +38788,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" @@ -38797,7 +38797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -38923,7 +38923,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Check Commits", @@ -38939,7 +38939,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -39005,7 +39005,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" @@ -39013,7 +39013,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39108,7 +39108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39118,7 +39118,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 42, @@ -39181,7 +39181,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39192,7 +39192,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -39269,7 +39269,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enforcement": "enabled" @@ -39283,7 +39283,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -39344,7 +39344,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39355,7 +39355,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Responds with effective values inherited from owner and/or global level.", + "description": "

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

    ", "example": { "id": 42, "name": "Check Commits", @@ -39447,13 +39447,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -39516,7 +39516,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_ids": "KEY_IDS" @@ -39524,7 +39524,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39570,13 +39570,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -39647,7 +39647,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "token_id": "TOKEN_ID" @@ -39655,7 +39655,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39702,7 +39702,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "monalisa", @@ -39712,7 +39712,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -39780,7 +39780,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "thenewmonalisa" @@ -39792,7 +39792,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename user. It may take a few minutes to complete.", "url": "https://api.github.com/user/1" @@ -39833,7 +39833,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39841,7 +39841,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39892,7 +39892,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39901,7 +39901,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when getting an existing impersonation OAuth token", + "description": "

    Response when getting an existing impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -39929,7 +39929,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39938,7 +39938,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when creating a new impersonation OAuth token", + "description": "

    Response when creating a new impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -40000,7 +40000,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -40008,7 +40008,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40045,7 +40045,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -40053,7 +40053,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40090,7 +40090,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -40098,7 +40098,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40146,7 +40146,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -40154,7 +40154,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40202,7 +40202,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -40210,7 +40210,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40269,13 +40269,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -40430,13 +40430,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -40523,13 +40523,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -40646,13 +40646,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -40750,7 +40750,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40759,7 +40759,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -40889,7 +40889,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40898,7 +40898,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -40958,7 +40958,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -40966,7 +40966,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41033,7 +41033,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41042,7 +41042,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", @@ -41141,7 +41141,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41150,7 +41150,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -41247,7 +41247,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41256,7 +41256,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -41356,7 +41356,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41364,7 +41364,7 @@ }, "response": { "statusCode": "204", - "description": "Response if gist is starred" + "description": "

    Response if gist is starred

    " } } ], @@ -41413,7 +41413,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41421,7 +41421,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41470,7 +41470,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41478,7 +41478,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41536,7 +41536,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -41546,7 +41546,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -41638,7 +41638,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -41647,7 +41647,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -41758,7 +41758,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41767,7 +41767,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -41862,7 +41862,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -41871,7 +41871,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -41958,7 +41958,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -41968,7 +41968,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -42070,7 +42070,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -42080,7 +42080,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -42159,7 +42159,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -42168,7 +42168,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42251,7 +42251,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "Content of the blob", @@ -42265,7 +42265,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" @@ -42340,7 +42340,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42351,7 +42351,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", "encoding": "base64", @@ -42614,7 +42614,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -42637,7 +42637,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -42735,7 +42735,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42746,7 +42746,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", @@ -42860,7 +42860,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42871,7 +42871,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/feature-a", @@ -42949,7 +42949,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42960,7 +42960,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -43051,7 +43051,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "refs/heads/featureA", @@ -43065,7 +43065,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -43156,7 +43156,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", @@ -43171,7 +43171,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -43241,7 +43241,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43251,7 +43251,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -43425,7 +43425,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag": "v0.0.1", @@ -43446,7 +43446,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -43528,7 +43528,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43539,7 +43539,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -43767,7 +43767,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -43788,7 +43788,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", @@ -43880,7 +43880,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43891,7 +43891,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -43927,7 +43927,7 @@ { "key": "response-recursively-retrieving-a-tree", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43938,7 +43938,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response recursively retrieving a tree", + "description": "

    Response recursively retrieving a tree

    ", "example": { "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", @@ -43991,13 +43991,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "Actionscript", "Android", @@ -44047,7 +44047,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "name": "NAME" @@ -44056,7 +44056,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" @@ -44231,13 +44231,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -44647,7 +44647,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -44656,7 +44656,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -45085,7 +45085,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45095,7 +45095,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -45423,7 +45423,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -45444,7 +45444,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -45676,7 +45676,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45687,7 +45687,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -46047,7 +46047,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -46070,7 +46070,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -46323,7 +46323,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46333,7 +46333,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46404,7 +46404,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46414,7 +46414,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46549,13 +46549,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -46892,7 +46892,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46902,7 +46902,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -46983,7 +46983,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46993,7 +46993,7 @@ }, "response": { "statusCode": "204", - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned." + "description": "

    If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

    " } } ], @@ -47066,7 +47066,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -47083,7 +47083,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -47309,7 +47309,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -47326,7 +47326,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -47586,7 +47586,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47596,7 +47596,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -47692,7 +47692,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47703,7 +47703,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -47804,7 +47804,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -47818,7 +47818,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -47908,7 +47908,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47918,7 +47918,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -48001,7 +48001,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48012,7 +48012,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -48119,7 +48119,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -48133,7 +48133,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -48246,7 +48246,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48256,7 +48256,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -48483,7 +48483,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48494,7 +48494,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", @@ -48785,7 +48785,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48796,7 +48796,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -48911,7 +48911,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48922,7 +48922,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -49016,7 +49016,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -49033,7 +49033,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -49131,7 +49131,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -49148,7 +49148,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -49231,7 +49231,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49241,7 +49241,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49309,7 +49309,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49321,7 +49321,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -49404,7 +49404,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49414,7 +49414,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -49513,7 +49513,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "bug", @@ -49528,7 +49528,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -49600,7 +49600,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49611,7 +49611,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -49708,7 +49708,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "bug :bug:", @@ -49724,7 +49724,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -49788,7 +49788,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49798,7 +49798,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49871,7 +49871,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49882,7 +49882,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -50011,7 +50011,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50021,7 +50021,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", @@ -50154,7 +50154,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -50170,7 +50170,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -50270,7 +50270,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50281,7 +50281,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -50421,7 +50421,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -50438,7 +50438,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -50530,7 +50530,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50540,7 +50540,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50619,7 +50619,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50629,7 +50629,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50695,13 +50695,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "mit", @@ -50793,7 +50793,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "license": "LICENSE" @@ -50802,7 +50802,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "mit", "name": "MIT License", @@ -50885,7 +50885,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50895,7 +50895,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "LICENSE", "path": "LICENSE", @@ -50988,12 +50988,12 @@ "key": "200", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51052,12 +51052,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51084,13 +51084,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "verifiable_password_authentication": true, "packages": [ @@ -51141,12 +51141,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51173,12 +51173,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51229,7 +51229,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51239,7 +51239,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "description": "

    Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

    ", "example": [ [ 1302998400, @@ -51300,7 +51300,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51310,7 +51310,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "days": [ @@ -51379,7 +51379,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51389,7 +51389,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "
      \n
    • w - Start of the week, given as a Unix timestamp.
    • \n
    • a - Number of additions
    • \n
    • d - Number of deletions
    • \n
    • c - Number of commits
    • \n
    ", "example": [ { "author": { @@ -51476,7 +51476,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51486,7 +51486,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The array order is oldest week (index 0) to most recent week.", + "description": "

    The array order is oldest week (index 0) to most recent week.

    ", "example": { "all": [ 11, @@ -51646,7 +51646,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51656,7 +51656,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "description": "

    For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

    ", "example": [ [ 0, @@ -51735,13 +51735,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -51810,7 +51810,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -51819,7 +51819,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/applications/grants/1", @@ -51882,7 +51882,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -51890,7 +51890,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51957,13 +51957,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -52111,13 +52111,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52261,7 +52261,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -52270,7 +52270,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52298,7 +52298,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -52307,7 +52307,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.3/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.3/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "description": "

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

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52451,7 +52451,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -52461,7 +52461,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52489,7 +52489,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -52499,7 +52499,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response if returning a new token", + "description": "

    Response if returning a new token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52565,7 +52565,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -52574,7 +52574,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52719,7 +52719,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -52728,7 +52728,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -52790,7 +52790,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -52798,7 +52798,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52860,13 +52860,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -52923,7 +52923,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52932,7 +52932,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "github", "id": 1, @@ -53196,7 +53196,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "billing_email": "mona@github.com", @@ -53217,7 +53217,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -53372,7 +53372,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -53381,7 +53381,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "actor_ip": "88.123.45.123", @@ -53571,7 +53571,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -53580,7 +53580,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "installations": [ @@ -53682,13 +53682,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -53771,7 +53771,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -53780,7 +53780,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -53883,7 +53883,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -53892,7 +53892,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -53968,7 +53968,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -53977,7 +53977,7 @@ }, "response": { "statusCode": "204", - "description": "Response if requester is an organization member and user is a member" + "description": "

    Response if requester is an organization member and user is a member

    " } } ], @@ -54031,7 +54031,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54040,7 +54040,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54090,7 +54090,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54100,7 +54100,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -54210,7 +54210,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54220,7 +54220,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -54314,7 +54314,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54323,7 +54323,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54386,7 +54386,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -54395,7 +54395,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -54463,7 +54463,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54472,7 +54472,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a public member" + "description": "

    Response if user is a public member

    " } } ], @@ -54522,7 +54522,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54531,7 +54531,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54581,7 +54581,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -54590,7 +54590,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54649,13 +54649,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", @@ -54790,7 +54790,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -54799,7 +54799,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", @@ -54898,7 +54898,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "active" @@ -54910,7 +54910,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -55033,7 +55033,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -55042,7 +55042,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -55110,7 +55110,7 @@ { "key": "202", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55119,13 +55119,13 @@ }, "response": { "statusCode": "202", - "description": "User is getting converted asynchronously" + "description": "

    User is getting converted asynchronously

    " } }, { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55134,7 +55134,7 @@ }, "response": { "statusCode": "204", - "description": "User was converted" + "description": "

    User was converted

    " } } ], @@ -55192,7 +55192,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55201,7 +55201,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -55262,7 +55262,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -55271,7 +55271,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -55547,7 +55547,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -55568,7 +55568,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -55641,7 +55641,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55651,7 +55651,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -55892,7 +55892,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -55908,7 +55908,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -55980,7 +55980,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55989,7 +55989,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56039,7 +56039,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -56049,7 +56049,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -56159,7 +56159,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -56169,7 +56169,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -56239,7 +56239,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -56249,7 +56249,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -56340,7 +56340,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -56351,7 +56351,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -56457,7 +56457,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -56467,7 +56467,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -56521,7 +56521,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -56530,7 +56530,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56583,7 +56583,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56593,7 +56593,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -56734,7 +56734,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "source": { @@ -56750,7 +56750,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -56897,7 +56897,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "cname": "octocatblog.com", @@ -56913,7 +56913,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56967,7 +56967,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56976,7 +56976,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -57048,7 +57048,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57058,7 +57058,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", @@ -57137,7 +57137,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57147,7 +57147,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", "status": "queued" @@ -57197,7 +57197,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57207,7 +57207,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -57293,7 +57293,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57304,7 +57304,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -57409,7 +57409,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -57418,7 +57418,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -57515,7 +57515,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Organization Roadmap", @@ -57528,7 +57528,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -57619,7 +57619,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -57628,7 +57628,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -57776,7 +57776,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -57785,7 +57785,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -57880,7 +57880,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -57888,7 +57888,7 @@ }, "response": { "statusCode": "204", - "description": "Delete Success" + "description": "

    Delete Success

    " } } ], @@ -57987,7 +57987,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -57997,7 +57997,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", @@ -58119,7 +58119,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Projects Documentation", @@ -58133,7 +58133,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -58243,13 +58243,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", @@ -58369,7 +58369,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -58378,7 +58378,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/users/octocat", @@ -58458,7 +58458,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -58467,7 +58467,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -58581,7 +58581,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -58590,7 +58590,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -58679,7 +58679,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -58687,7 +58687,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58767,7 +58767,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -58775,7 +58775,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58865,7 +58865,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -58874,7 +58874,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/cards/1478", @@ -58998,7 +58998,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59007,7 +59007,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -59131,7 +59131,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -59140,7 +59140,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -59248,7 +59248,7 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -59257,7 +59257,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59323,7 +59323,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -59332,7 +59332,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59398,7 +59398,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -59408,7 +59408,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "permission": "admin", "user": { @@ -59490,7 +59490,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59499,7 +59499,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -59576,7 +59576,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59585,7 +59585,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -59644,7 +59644,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59652,7 +59652,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59716,7 +59716,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -59724,7 +59724,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59795,7 +59795,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -59804,7 +59804,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/367", @@ -59879,7 +59879,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -59888,7 +59888,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -60043,7 +60043,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60053,7 +60053,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -60694,7 +60694,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Amazing new feature", @@ -60710,7 +60710,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -61306,7 +61306,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61317,7 +61317,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "

    Pass the appropriate media type to fetch diff and patch formats.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -61968,7 +61968,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "new title", @@ -61985,7 +61985,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -62599,7 +62599,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62610,7 +62610,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -62763,7 +62763,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62774,7 +62774,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", @@ -62851,7 +62851,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62861,7 +62861,7 @@ }, "response": { "statusCode": "204", - "description": "Response if pull request has been merged" + "description": "

    Response if pull request has been merged

    " } } ], @@ -62963,7 +62963,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62974,7 +62974,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if merge was successful", + "description": "

    if merge was successful

    ", "example": { "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "merged": true, @@ -63065,7 +63065,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" @@ -63079,7 +63079,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Updating pull request branch.", "url": "https://github.com/repos/octocat/Hello-World/pulls/53" @@ -63195,7 +63195,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63205,7 +63205,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -63318,7 +63318,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63329,7 +63329,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -63455,7 +63455,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "I like this too!" @@ -63469,7 +63469,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -63580,7 +63580,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63590,7 +63590,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63704,7 +63704,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63715,7 +63715,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -63852,11 +63852,15 @@ }, { "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "description": "

    This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + }, "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, { @@ -63923,7 +63927,7 @@ "key": "example-for-a-multi-line-comment", "request": { "contentType": "application/json", - "description": "Example for a multi-line comment", + "description": "

    Example for a multi-line comment

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!", @@ -63943,7 +63947,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -64004,7 +64008,7 @@ } ], "previews": [], - "descriptionHTML": "

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    \n

    You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required.

    \n

    Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    \n

    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.

    ", + "descriptionHTML": "

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    \n

    The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

    \n

    Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    \n

    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.

    ", "statusCodes": [ { "httpStatusCode": "201", @@ -64082,7 +64086,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!" @@ -64097,7 +64101,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -64232,7 +64236,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64243,7 +64247,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "users": [ { @@ -64364,7 +64368,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -64385,7 +64389,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -65032,7 +65036,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -65052,7 +65056,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -65131,7 +65135,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65142,7 +65146,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The list of reviews returns in chronological order.", + "description": "

    The list of reviews returns in chronological order.

    ", "example": [ { "id": 80, @@ -65440,7 +65444,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", @@ -65463,7 +65467,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65574,7 +65578,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65586,7 +65590,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65704,7 +65708,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is close to perfect! Please address the suggested inline change. And add more about this." @@ -65719,7 +65723,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65826,7 +65830,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65838,7 +65842,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -65967,7 +65971,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65979,7 +65983,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -66121,7 +66125,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66133,7 +66137,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -66269,7 +66273,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66281,7 +66285,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -66362,13 +66366,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "resources": { "core": { @@ -66521,7 +66525,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66533,7 +66537,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -66646,7 +66650,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66661,7 +66665,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "

    Response when the reaction type has already been added to this team discussion comment

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66694,7 +66698,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -66709,7 +66713,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -66812,7 +66816,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66824,7 +66828,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -66916,7 +66920,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -66927,7 +66931,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67031,7 +67035,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67045,7 +67049,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67078,7 +67082,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67092,7 +67096,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67186,7 +67190,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -67197,7 +67201,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67234,7 +67238,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "reaction_id": "REACTION_ID" @@ -67242,7 +67246,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67350,7 +67354,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67361,7 +67365,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67469,7 +67473,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67483,7 +67487,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67516,7 +67520,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67530,7 +67534,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67628,7 +67632,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67639,7 +67643,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -67731,7 +67735,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67742,7 +67746,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -67850,7 +67854,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67864,7 +67868,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -67897,7 +67901,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -67911,7 +67915,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68009,7 +68013,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68020,7 +68024,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68112,7 +68116,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68123,7 +68127,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -68235,7 +68239,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -68249,7 +68253,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68282,7 +68286,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -68296,7 +68300,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68394,7 +68398,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68405,7 +68409,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68497,7 +68501,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68508,7 +68512,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -68616,7 +68620,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -68630,7 +68634,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68663,7 +68667,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -68677,7 +68681,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -68775,7 +68779,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68786,7 +68790,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68876,7 +68880,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68887,7 +68891,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -68993,7 +68997,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -69007,7 +69011,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -69040,7 +69044,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -69054,7 +69058,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -69152,7 +69156,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69163,7 +69167,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -69255,7 +69259,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -69266,7 +69270,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -69370,7 +69374,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -69384,7 +69388,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -69493,7 +69497,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -69503,7 +69507,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -69598,7 +69602,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -69611,7 +69615,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -69661,6 +69665,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69705,7 +69710,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69715,7 +69720,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", @@ -69806,8 +69811,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69815,6 +69819,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69909,7 +69914,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -69928,7 +69933,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -70018,8 +70023,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70027,6 +70031,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", "title": "Generate release notes content for a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70091,7 +70096,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -70107,7 +70112,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Name and body of generated release notes", + "description": "

    Name and body of generated release notes

    ", "example": { "name": "Release v1.0.0 is now available!", "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa" @@ -70126,8 +70131,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70135,6 +70139,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70161,7 +70166,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70171,7 +70176,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -70257,8 +70262,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70266,6 +70270,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70302,7 +70307,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70313,7 +70318,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -70403,8 +70408,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70412,6 +70416,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70447,7 +70452,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70458,7 +70463,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#hypermedia).", + "description": "

    Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -70548,8 +70553,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70557,6 +70561,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70648,7 +70653,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -70667,7 +70672,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -70753,8 +70758,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70762,6 +70766,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70797,7 +70802,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70807,7 +70812,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70818,8 +70823,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ @@ -70865,7 +70869,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70876,7 +70880,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "

    To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -71004,7 +71008,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "foo-1.0.0-osx.zip", @@ -71019,7 +71023,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -71108,7 +71112,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71118,7 +71122,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71191,7 +71195,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71202,7 +71206,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", @@ -71311,7 +71315,7 @@ "key": "default", "request": { "contentType": "*/*", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71322,7 +71326,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for successful upload", + "description": "

    Response for successful upload

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -71465,7 +71469,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -71474,7 +71478,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -71797,7 +71801,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -71815,7 +71819,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -71993,7 +71997,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72003,7 +72007,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -73032,7 +73036,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -73051,7 +73055,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -73622,7 +73626,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73631,7 +73635,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73716,7 +73720,7 @@ { "key": "response-if-repository-contains-content", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73726,7 +73730,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if repository contains content", + "description": "

    if repository contains content

    ", "example": [ { "login": "octocat", @@ -73831,7 +73835,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "event_type": "on-demand-test", @@ -73847,7 +73851,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73897,7 +73901,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73907,7 +73911,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "C": 78769, "Python": 7769 @@ -73975,7 +73979,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73985,7 +73989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "v0.1", @@ -74061,7 +74065,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74071,7 +74075,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -74151,7 +74155,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74161,7 +74165,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -74233,7 +74237,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "names": [ @@ -74251,7 +74255,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -74336,7 +74340,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_owner": "github", @@ -74353,7 +74357,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -74674,7 +74678,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "owner": "octocat", @@ -74691,7 +74695,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -74863,13 +74867,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -75085,13 +75089,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -75474,13 +75478,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -75727,7 +75731,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -75736,7 +75740,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -75900,7 +75904,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -75910,7 +75914,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -75983,7 +75987,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", @@ -75997,7 +76001,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "response", + "description": "

    response

    ", "example": { "id": 1, "key_prefix": "TICKET-", @@ -76061,7 +76065,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76072,7 +76076,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key_prefix": "TICKET-", @@ -76136,7 +76140,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76146,7 +76150,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -76217,7 +76221,7 @@ { "key": "response-if-content-is-a-file", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76228,7 +76232,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a file", + "description": "

    Response if content is a file

    ", "example": { "type": "file", "encoding": "base64", @@ -76252,7 +76256,7 @@ { "key": "response-if-content-is-a-directory", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76263,7 +76267,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a directory", + "description": "

    Response if content is a directory

    ", "example": [ { "type": "file", @@ -76303,7 +76307,7 @@ { "key": "response-if-content-is-a-symlink", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76314,7 +76318,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a symlink", + "description": "

    Response if content is a symlink

    ", "example": { "type": "symlink", "target": "/path/to/symlink/target", @@ -76337,7 +76341,7 @@ { "key": "response-if-content-is-a-submodule", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76348,7 +76352,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a submodule", + "description": "

    Response if content is a submodule

    ", "example": { "type": "submodule", "submodule_git_url": "git://github.com/jquery/qunit.git", @@ -76633,7 +76637,7 @@ "key": "example-for-creating-a-file", "request": { "contentType": "application/json", - "description": "Example for creating a file", + "description": "

    Example for creating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -76652,7 +76656,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -76711,7 +76715,7 @@ "key": "example-for-updating-a-file", "request": { "contentType": "application/json", - "description": "Example for updating a file", + "description": "

    Example for updating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "a new commit message", @@ -76731,7 +76735,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -76994,7 +76998,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -77013,7 +77017,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": null, "commit": { @@ -77121,7 +77125,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77131,7 +77135,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -77222,7 +77226,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77233,7 +77237,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -77314,7 +77318,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77324,7 +77328,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77379,7 +77383,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77389,7 +77393,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77471,7 +77475,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77481,7 +77485,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -77658,7 +77662,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77668,7 +77672,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -78241,7 +78245,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78250,7 +78254,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -78300,7 +78304,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78309,7 +78313,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -78393,13 +78397,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 7, "incomplete_results": false, @@ -78579,13 +78583,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "incomplete_results": false, @@ -78808,13 +78812,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 280, "incomplete_results": false, @@ -79021,13 +79025,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "incomplete_results": false, @@ -79153,13 +79157,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 40, "incomplete_results": false, @@ -79336,13 +79340,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 6, "incomplete_results": false, @@ -79513,13 +79517,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 12, "incomplete_results": false, @@ -79648,7 +79652,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -79657,7 +79661,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -80255,7 +80259,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80265,7 +80269,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -80375,7 +80379,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80386,7 +80390,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -80499,7 +80503,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "resolved", @@ -80514,7 +80518,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -80633,7 +80637,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80644,7 +80648,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "commit", @@ -80755,7 +80759,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -80764,7 +80768,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -80910,7 +80914,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Justice League", @@ -80925,7 +80929,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -81026,7 +81030,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81036,7 +81040,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -81193,7 +81197,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -81208,7 +81212,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -81301,7 +81305,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81310,7 +81314,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81374,7 +81378,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81384,7 +81388,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -81482,7 +81486,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81493,7 +81497,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -81609,7 +81613,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81619,7 +81623,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81678,7 +81682,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81688,7 +81692,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81752,7 +81756,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81762,7 +81766,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -81932,7 +81936,7 @@ { "key": "alternative-response-with-repository-permissions", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81944,7 +81948,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with repository permissions", + "description": "

    Alternative response with repository permissions

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -82282,7 +82286,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -82293,7 +82297,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82357,7 +82361,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -82368,7 +82372,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82432,7 +82436,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -82442,7 +82446,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -82507,7 +82511,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -82516,7 +82520,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -82664,7 +82668,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -82678,7 +82682,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the updated information already exists", + "description": "

    Response when the updated information already exists

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -82732,7 +82736,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -82746,7 +82750,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -82846,7 +82850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -82854,7 +82858,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82917,7 +82921,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -82926,7 +82930,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -83019,7 +83023,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83029,7 +83033,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -83136,7 +83140,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83145,7 +83149,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83203,7 +83207,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83212,7 +83216,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83275,7 +83279,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -83284,7 +83288,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -83449,7 +83453,7 @@ { "key": "alternative-response-with-extra-repository-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83460,7 +83464,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with extra repository information", + "description": "

    Alternative response with extra repository information

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -83786,7 +83790,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83796,7 +83800,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83859,7 +83863,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -83869,7 +83873,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83924,7 +83928,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -83933,7 +83937,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -84019,13 +84023,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -84176,7 +84180,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -84187,7 +84191,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -84300,7 +84304,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -84314,7 +84318,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84423,7 +84427,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -84435,7 +84439,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84555,7 +84559,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -84570,7 +84574,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84679,7 +84683,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -84690,7 +84694,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -84768,7 +84772,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -84778,7 +84782,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -84882,7 +84886,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -84895,7 +84899,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -84995,7 +84999,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -85006,7 +85010,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -85117,7 +85121,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -85131,7 +85135,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -85231,7 +85235,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -85241,7 +85245,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85330,7 +85334,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -85340,7 +85344,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -85468,7 +85472,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -85482,7 +85486,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -85587,7 +85591,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -85598,7 +85602,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -85723,7 +85727,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -85737,7 +85741,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -85842,7 +85846,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -85852,7 +85856,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85921,7 +85925,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -85930,7 +85934,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -86049,7 +86053,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -86062,7 +86066,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -86158,7 +86162,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -86168,7 +86172,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -86284,7 +86288,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -86297,7 +86301,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -86393,7 +86397,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -86402,7 +86406,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -86483,7 +86487,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86493,7 +86497,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -86570,7 +86574,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86581,7 +86585,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -86661,7 +86665,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86672,7 +86676,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -86740,7 +86744,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86750,7 +86754,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -86824,7 +86828,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -86833,7 +86837,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -86905,7 +86909,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -86914,7 +86918,7 @@ }, "response": { "statusCode": "204", - "description": "if user is a member" + "description": "

    if user is a member

    " } } ], @@ -86964,7 +86968,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -86973,7 +86977,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87031,7 +87035,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -87040,7 +87044,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87090,7 +87094,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -87100,7 +87104,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -87171,7 +87175,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -87181,7 +87185,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -87244,7 +87248,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -87253,7 +87257,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87287,13 +87291,13 @@ { "key": "response-with-public-and-private-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public and private profile information", + "description": "

    Response with public and private profile information

    ", "example": { "login": "octocat", "id": 1, @@ -87344,13 +87348,13 @@ { "key": "response-with-public-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public profile information", + "description": "

    Response with public profile information

    ", "example": { "login": "octocat", "id": 1, @@ -87517,13 +87521,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -87634,13 +87638,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -87703,7 +87707,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -87712,7 +87716,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "octocat", "id": 1, @@ -87752,7 +87756,7 @@ { "key": "response-with-git-hub-plan-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -87761,7 +87765,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with GitHub plan information", + "description": "

    Response with GitHub plan information

    ", "example": { "login": "octocat", "id": 1, @@ -87866,7 +87870,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -87875,7 +87879,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "contexts": [ { @@ -87940,13 +87944,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -88016,13 +88020,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@octocat.org", @@ -88107,12 +88111,12 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88178,13 +88182,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -88256,13 +88260,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -88342,13 +88346,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -88419,7 +88423,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -88427,7 +88431,7 @@ }, "response": { "statusCode": "204", - "description": "if the person is followed by the authenticated user" + "description": "

    if the person is followed by the authenticated user

    " } } ], @@ -88480,7 +88484,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -88488,7 +88492,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88541,7 +88545,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -88549,7 +88553,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88620,7 +88624,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -88629,7 +88633,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -88706,7 +88710,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -88715,7 +88719,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -88783,7 +88787,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -88792,7 +88796,7 @@ }, "response": { "statusCode": "204", - "description": "if the user follows the target user" + "description": "

    if the user follows the target user

    " } } ], @@ -88844,13 +88848,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -88941,13 +88945,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -89039,7 +89043,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -89048,7 +89052,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -89136,7 +89140,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -89144,7 +89148,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -89219,7 +89223,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -89228,7 +89232,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -89313,13 +89317,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -89406,13 +89410,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -89478,7 +89482,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -89487,7 +89491,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -89549,7 +89553,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -89557,7 +89561,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -89628,7 +89632,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -89637,7 +89641,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -89702,7 +89706,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -89713,7 +89717,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -89832,7 +89836,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -89843,7 +89847,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -89924,7 +89928,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -89935,7 +89939,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -90035,7 +90039,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90047,7 +90051,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -90162,7 +90166,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90173,7 +90177,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -90247,7 +90251,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90257,7 +90261,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Repository", @@ -90546,7 +90550,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -90569,7 +90573,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -90662,7 +90666,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -90673,7 +90677,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -90987,7 +90991,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -91004,7 +91008,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -91093,7 +91097,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -91103,7 +91107,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -91162,7 +91166,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -91172,7 +91176,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -91231,7 +91235,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -91241,7 +91245,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 925bd7ff47..3b28d7e3e6 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -52,7 +52,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62,7 +62,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -146,7 +146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -157,7 +157,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 11, "node_id": "MDg6QXJ0aWZhY3QxMQ==", @@ -224,7 +224,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -234,7 +234,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -298,7 +298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -309,7 +309,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -382,7 +382,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -393,7 +393,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -461,7 +461,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -470,7 +470,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_organizations": "all", "allowed_actions": "selected", @@ -542,7 +542,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_organizations": "all", @@ -554,7 +554,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -609,7 +609,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -618,7 +618,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -689,7 +689,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -703,7 +703,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -749,7 +749,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -758,7 +758,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -804,7 +804,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -813,7 +813,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -850,7 +850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -859,7 +859,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -927,7 +927,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -943,7 +943,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -980,7 +980,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -989,7 +989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_repositories": "all", "allowed_actions": "selected", @@ -1061,7 +1061,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_repositories": "all", @@ -1073,7 +1073,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1128,7 +1128,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1137,7 +1137,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -1317,7 +1317,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -1331,7 +1331,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1377,7 +1377,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1386,7 +1386,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1432,7 +1432,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1441,7 +1441,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1478,7 +1478,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1487,7 +1487,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1555,7 +1555,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1571,7 +1571,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1617,7 +1617,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1627,7 +1627,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled": true, "allowed_actions": "selected", @@ -1703,7 +1703,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled": true, @@ -1716,7 +1716,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1762,7 +1762,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1772,7 +1772,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1849,7 +1849,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1866,7 +1866,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1923,7 +1923,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1932,7 +1932,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "secrets": [ @@ -1993,7 +1993,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -2002,7 +2002,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2052,7 +2052,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2062,7 +2062,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2162,7 +2162,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2180,14 +2180,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2205,7 +2205,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -2255,7 +2255,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2264,7 +2264,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2328,7 +2328,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2338,7 +2338,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -2472,7 +2472,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -2486,7 +2486,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2541,7 +2541,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2551,7 +2551,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -2610,7 +2610,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2620,7 +2620,7 @@ }, "response": { "statusCode": "204", - "description": "Response when repository was removed from the selected list" + "description": "

    Response when repository was removed from the selected list

    " } } ], @@ -2688,7 +2688,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2698,7 +2698,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -2759,7 +2759,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2769,7 +2769,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2828,7 +2828,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2839,7 +2839,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2920,7 +2920,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2934,14 +2934,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2955,7 +2955,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3014,7 +3014,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3024,7 +3024,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3088,7 +3088,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3098,7 +3098,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -3159,7 +3159,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3169,7 +3169,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -3228,7 +3228,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3239,7 +3239,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -3320,7 +3320,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3334,14 +3334,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -3355,7 +3355,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3414,7 +3414,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "repository_id": "REPOSITORY_ID", @@ -3424,7 +3424,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -3481,7 +3481,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -3490,7 +3490,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -3617,7 +3617,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3638,7 +3638,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3693,7 +3693,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3703,7 +3703,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3793,7 +3793,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3807,7 +3807,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "Expensive hardware runners", @@ -3862,7 +3862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3871,7 +3871,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3935,7 +3935,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3945,7 +3945,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -4025,7 +4025,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -4040,7 +4040,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4095,7 +4095,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4105,7 +4105,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4160,7 +4160,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4170,7 +4170,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4234,7 +4234,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4244,7 +4244,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -4363,7 +4363,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -4378,7 +4378,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4433,7 +4433,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4443,7 +4443,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4498,7 +4498,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4508,7 +4508,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4563,7 +4563,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -4572,7 +4572,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -4704,7 +4704,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4725,7 +4725,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4781,7 +4781,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4791,7 +4791,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4882,7 +4882,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4896,7 +4896,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4952,7 +4952,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4961,7 +4961,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5025,7 +5025,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5035,7 +5035,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -5342,7 +5342,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -5357,7 +5357,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5412,7 +5412,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5422,7 +5422,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5477,7 +5477,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5487,7 +5487,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5551,7 +5551,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5561,7 +5561,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5680,7 +5680,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -5695,7 +5695,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5750,7 +5750,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5760,7 +5760,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5815,7 +5815,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5825,7 +5825,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5882,7 +5882,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5891,7 +5891,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5986,7 +5986,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -5995,7 +5995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -6074,7 +6074,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6083,7 +6083,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -6124,7 +6124,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -6133,7 +6133,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -6183,7 +6183,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6193,7 +6193,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -6268,7 +6268,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6277,7 +6277,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6323,7 +6323,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6333,7 +6333,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -6424,7 +6424,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -6440,7 +6440,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -6535,7 +6535,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -6551,7 +6551,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -6630,7 +6630,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6640,7 +6640,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "labels": [ @@ -6723,7 +6723,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -6734,7 +6734,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -6822,7 +6822,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6831,7 +6831,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -6926,7 +6926,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -6935,7 +6935,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -7014,7 +7014,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -7023,7 +7023,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -7064,7 +7064,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -7073,7 +7073,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -7123,7 +7123,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -7133,7 +7133,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -7208,7 +7208,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -7217,7 +7217,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7263,7 +7263,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -7273,7 +7273,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -7364,7 +7364,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -7380,7 +7380,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -7475,7 +7475,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -7491,7 +7491,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -7570,7 +7570,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -7580,7 +7580,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "labels": [ @@ -7659,7 +7659,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -7670,7 +7670,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -7767,7 +7767,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7777,7 +7777,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -7881,7 +7881,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7891,7 +7891,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -7979,7 +7979,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7989,7 +7989,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -8039,7 +8039,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8049,7 +8049,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -8108,7 +8108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8119,7 +8119,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -8203,7 +8203,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8213,7 +8213,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8268,7 +8268,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8279,7 +8279,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -8379,7 +8379,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -8396,7 +8396,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -8500,7 +8500,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -8517,7 +8517,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -8605,7 +8605,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8616,7 +8616,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "labels": [ @@ -8704,7 +8704,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8716,7 +8716,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 4, "labels": [ @@ -8806,7 +8806,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8817,7 +8817,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 399444496, "run_id": 29679449, @@ -8978,7 +8978,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8988,7 +8988,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9075,7 +9075,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9086,7 +9086,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "jobs": [ @@ -9334,7 +9334,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9344,7 +9344,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -9590,7 +9590,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9601,7 +9601,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 30433642, "name": "Build", @@ -9831,7 +9831,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9841,7 +9841,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9896,7 +9896,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9907,7 +9907,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "state": "approved", @@ -9999,7 +9999,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10009,7 +10009,7 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10068,7 +10068,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10078,7 +10078,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10133,7 +10133,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10143,7 +10143,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10206,7 +10206,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10217,7 +10217,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "environment": { @@ -10377,7 +10377,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10388,7 +10388,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -10483,7 +10483,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10493,7 +10493,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10644,7 +10644,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10655,7 +10655,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -10902,7 +10902,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10912,7 +10912,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "workflows": [ @@ -11003,7 +11003,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11014,7 +11014,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", @@ -11088,7 +11088,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11098,7 +11098,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11184,7 +11184,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -11201,7 +11201,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11263,7 +11263,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11273,7 +11273,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11323,12 +11323,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11404,7 +11404,7 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11413,7 +11413,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11484,7 +11484,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -11492,7 +11492,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11556,7 +11556,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11565,7 +11565,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11620,7 +11620,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -11628,7 +11628,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11692,7 +11692,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -11701,7 +11701,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11756,7 +11756,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -11764,7 +11764,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11819,7 +11819,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -11827,7 +11827,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11882,7 +11882,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -11890,7 +11890,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11919,13 +11919,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", @@ -12057,13 +12057,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -12213,24 +12213,24 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -12283,7 +12283,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -12292,7 +12292,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": "1", "repository": { @@ -12425,7 +12425,7 @@ { "key": "205", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -12433,7 +12433,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -12478,7 +12478,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -12487,7 +12487,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -12556,7 +12556,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -12565,7 +12565,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -12622,7 +12622,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -12630,7 +12630,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12746,7 +12746,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12756,7 +12756,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -12900,7 +12900,7 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12909,14 +12909,14 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -12925,7 +12925,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -12995,7 +12995,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13005,7 +13005,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "login": "octocat", @@ -13033,7 +13033,7 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13043,7 +13043,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -13146,13 +13146,13 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -13283,13 +13283,13 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/vnd.github.v3.star+json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -13475,7 +13475,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13484,7 +13484,7 @@ }, "response": { "statusCode": "204", - "description": "Response if this repository is starred by you" + "description": "

    Response if this repository is starred by you

    " } } ], @@ -13546,7 +13546,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13555,7 +13555,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13617,7 +13617,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13626,7 +13626,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13725,7 +13725,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -13734,7 +13734,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -13925,7 +13925,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13935,7 +13935,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -14003,7 +14003,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14013,7 +14013,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if you subscribe to the repository", + "description": "

    if you subscribe to the repository

    ", "example": { "subscribed": true, "ignored": false, @@ -14095,7 +14095,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14105,7 +14105,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -14159,7 +14159,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -14168,7 +14168,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14214,13 +14214,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -14393,7 +14393,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -14402,7 +14402,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -14538,13 +14538,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -14622,7 +14622,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "code": "CODE" @@ -14631,7 +14631,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -14749,13 +14749,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "The permissions the installation has are included under the `permissions` key.", + "description": "

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

    ", "example": [ { "id": 1, @@ -14849,7 +14849,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -14858,7 +14858,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -14954,7 +14954,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -14962,7 +14962,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -15846,7 +15846,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "respoitory": "Hello-World", @@ -15862,7 +15862,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", @@ -16054,7 +16054,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -16062,7 +16062,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16108,7 +16108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -16116,7 +16116,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16157,7 +16157,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "app_slug": "APP_SLUG" @@ -16166,7 +16166,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -16252,7 +16252,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -16261,7 +16261,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -16357,7 +16357,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -16367,7 +16367,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -16462,7 +16462,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -16471,7 +16471,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -16570,13 +16570,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -16738,12 +16738,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16789,13 +16789,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "You can find the permissions for the installation under the `permissions` key.", + "description": "

    You can find the permissions for the installation under the permissions key.

    ", "example": { "total_count": 2, "installations": [ @@ -16972,7 +16972,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -16981,7 +16981,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "description": "

    The access the user has to each repository is included in the hash under the permissions key.

    ", "example": { "total_count": 1, "repositories": [ @@ -17172,7 +17172,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -17181,7 +17181,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17244,7 +17244,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -17253,7 +17253,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17320,7 +17320,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -17331,7 +17331,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17388,7 +17388,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -17400,7 +17400,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -17503,7 +17503,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -17515,7 +17515,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -17614,7 +17614,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -17625,7 +17625,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -18545,7 +18545,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", @@ -18563,7 +18563,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -18679,13 +18679,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -18776,7 +18776,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content_type": "json", @@ -18788,7 +18788,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -18840,13 +18840,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -18919,7 +18919,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -18928,7 +18928,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -19016,7 +19016,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -19024,7 +19024,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -19090,7 +19090,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -19099,7 +19099,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Success", + "description": "

    Success

    ", "example": { "total_advanced_security_committers": 2, "repositories": [ @@ -19156,6 +19156,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -19209,7 +19210,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19219,7 +19220,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "master", @@ -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", @@ -19299,7 +19300,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19309,7 +19310,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -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", @@ -19384,7 +19385,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "my_renamed_branch" @@ -19398,7 +19399,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "master", "commit": { @@ -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", @@ -19567,7 +19568,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "branch": "main" @@ -19580,7 +19581,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The branch has been successfully synced with the upstream repository", + "description": "

    The branch has been successfully synced with the upstream repository

    ", "example": { "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", "merge_type": "fast-forward", @@ -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", @@ -19668,7 +19669,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base": "master", @@ -19683,7 +19684,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Successful Response (The resulting merge commit)", + "description": "

    Successful Response (The resulting merge commit)

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -19809,8 +19810,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -19857,7 +19857,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19868,7 +19868,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", "required_status_checks": { @@ -20868,7 +20868,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "required_status_checks": { @@ -20924,7 +20924,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -20992,7 +20992,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21002,7 +21002,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -21062,7 +21062,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21073,7 +21073,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -21133,7 +21133,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21144,7 +21144,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -21204,7 +21204,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21214,7 +21214,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -21274,7 +21274,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21285,7 +21285,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -21553,7 +21553,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "dismissal_restrictions": { @@ -21585,7 +21585,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -21694,7 +21694,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21704,7 +21704,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -21764,7 +21764,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21775,7 +21775,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -21839,7 +21839,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21850,7 +21850,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -21914,7 +21914,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21924,7 +21924,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -21984,7 +21984,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21995,7 +21995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -22148,7 +22148,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "strict": true, @@ -22165,7 +22165,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -22237,7 +22237,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22247,7 +22247,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -22303,7 +22303,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22314,7 +22314,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -22391,7 +22391,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22402,7 +22402,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci", "continuous-integration/jenkins" @@ -22488,7 +22488,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22499,7 +22499,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -22580,7 +22580,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22591,7 +22591,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -22658,7 +22658,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22669,7 +22669,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", @@ -22810,7 +22810,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22820,7 +22820,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -22876,7 +22876,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22887,7 +22887,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -23004,7 +23004,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23015,7 +23015,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -23132,7 +23132,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23143,7 +23143,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -23260,7 +23260,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23271,7 +23271,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -23374,7 +23374,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23385,7 +23385,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -23475,7 +23475,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23486,7 +23486,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -23576,7 +23576,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23587,7 +23587,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -23677,7 +23677,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23688,7 +23688,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -23764,7 +23764,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23775,7 +23775,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -23871,7 +23871,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23882,7 +23882,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -23978,7 +23978,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23989,7 +23989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -24085,7 +24085,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24096,7 +24096,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -25124,7 +25124,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Example of an in_progress conclusion", + "description": "

    Example of an in_progress conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -25146,7 +25146,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "

    Response for in_progress conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25243,7 +25243,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Example of a completed conclusion", + "description": "

    Example of a completed conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -25299,7 +25299,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "

    Response for completed conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25444,7 +25444,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25455,7 +25455,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -26541,7 +26541,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -26590,7 +26590,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -26753,7 +26753,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26764,7 +26764,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "path": "README.md", @@ -26833,7 +26833,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26843,7 +26843,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -26965,7 +26965,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26976,7 +26976,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -27191,7 +27191,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27202,7 +27202,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -27356,7 +27356,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -27369,7 +27369,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the suite already exists", + "description": "

    Response when the suite already exists

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -27676,7 +27676,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -27689,7 +27689,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the suite was created", + "description": "

    Response when the suite was created

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -28105,7 +28105,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "auto_trigger_checks": [ @@ -28123,7 +28123,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "preferences": { "auto_trigger_checks": [ @@ -28417,7 +28417,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28428,7 +28428,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -28783,7 +28783,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28793,7 +28793,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -28886,7 +28886,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28897,7 +28897,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_suites": [ @@ -29225,7 +29225,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29235,7 +29235,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 4, @@ -29421,7 +29421,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29432,7 +29432,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-06-19T11:21:34Z", @@ -29607,7 +29607,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", @@ -29623,7 +29623,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-08-25T21:28:36Z", @@ -29789,7 +29789,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29800,7 +29800,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -29967,7 +29967,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29977,7 +29977,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -30088,7 +30088,7 @@ { "key": "response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30099,7 +30099,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "ref": "refs/heads/main", "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", @@ -30199,7 +30199,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30210,7 +30210,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" @@ -30340,7 +30340,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30350,7 +30350,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -30429,7 +30429,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30440,7 +30440,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "processing_status": "complete", "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -30487,13 +30487,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "citizen_code_of_conduct", @@ -30548,7 +30548,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key": "KEY" @@ -30557,7 +30557,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "contributor_covenant", "name": "Contributor Covenant", @@ -30596,6 +30596,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -30655,7 +30656,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30665,7 +30666,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -30707,8 +30708,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30716,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", @@ -30751,7 +30752,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30761,7 +30762,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a collaborator" + "description": "

    Response if user is a collaborator

    " } } ], @@ -30776,8 +30777,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30785,6 +30785,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -30850,7 +30851,7 @@ "key": "response-when-a-new-invitation-is-created", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30861,7 +30862,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when a new invitation is created", + "description": "

    Response when a new invitation is created

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -31001,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", @@ -31010,6 +31010,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -31045,7 +31046,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31055,7 +31056,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -31066,8 +31067,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31075,6 +31075,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -31110,7 +31111,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31121,7 +31122,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if user has admin permissions", + "description": "

    if user has admin permissions

    ", "example": { "permission": "admin", "user": { @@ -31159,8 +31160,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -31215,7 +31215,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31225,7 +31225,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -31417,7 +31417,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31428,7 +31428,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -31601,7 +31601,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31611,7 +31611,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -31657,13 +31657,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -31835,7 +31835,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -31843,7 +31843,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -31896,7 +31896,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -31904,7 +31904,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -31943,6 +31943,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -32034,7 +32035,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32044,7 +32045,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -32151,8 +32152,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32160,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", @@ -32196,7 +32197,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32207,7 +32208,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "branch_5", @@ -32232,8 +32233,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32241,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", @@ -32295,7 +32296,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32306,7 +32307,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -32837,8 +32838,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32846,6 +32846,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -32900,7 +32901,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32911,7 +32912,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -33029,8 +33030,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33038,6 +33038,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -33091,7 +33092,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33102,7 +33103,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", @@ -33382,8 +33383,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -33438,7 +33438,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33448,7 +33448,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -33539,7 +33539,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33550,7 +33550,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -33654,7 +33654,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Nice change" @@ -33668,7 +33668,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -33761,7 +33761,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33771,7 +33771,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33849,7 +33849,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -33860,7 +33860,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -33990,7 +33990,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff", @@ -34007,7 +34007,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -34125,7 +34125,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34136,7 +34136,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "state": "success", "statuses": [ @@ -34316,7 +34316,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -34327,7 +34327,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -34466,7 +34466,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "success", @@ -34483,7 +34483,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", @@ -34574,7 +34574,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -34583,7 +34583,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "secrets": [ @@ -34644,7 +34644,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -34653,7 +34653,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -34703,7 +34703,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -34713,7 +34713,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "NPM_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -34813,7 +34813,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -34831,14 +34831,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -34856,7 +34856,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -34906,7 +34906,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -34915,7 +34915,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -34979,7 +34979,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -34989,7 +34989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -35123,7 +35123,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -35137,7 +35137,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35192,7 +35192,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -35202,7 +35202,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -35261,7 +35261,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -35271,7 +35271,7 @@ }, "response": { "statusCode": "204", - "description": "Response when repository was removed from the selected list" + "description": "

    Response when repository was removed from the selected list

    " } } ], @@ -35339,7 +35339,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -35349,7 +35349,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -35410,7 +35410,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -35420,7 +35420,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -35479,7 +35479,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -35490,7 +35490,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "MY_ARTIFACTORY_PASSWORD", "created_at": "2019-08-10T14:59:22Z", @@ -35571,7 +35571,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -35585,14 +35585,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -35606,7 +35606,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -35665,7 +35665,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -35675,7 +35675,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35690,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", @@ -35743,7 +35742,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -35753,7 +35752,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -35775,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", @@ -35839,7 +35838,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "octocat@octomac", @@ -35854,7 +35853,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -35878,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", @@ -35922,7 +35921,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -35933,7 +35932,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -35957,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", @@ -36001,7 +36000,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -36011,7 +36010,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36022,7 +36021,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -36034,6 +36034,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -36121,7 +36122,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -36131,7 +36132,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -36182,8 +36183,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -36191,6 +36191,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -36320,7 +36321,7 @@ "key": "simple-example", "request": { "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -36335,7 +36336,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -36396,8 +36397,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -36405,6 +36405,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -36440,7 +36441,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -36451,7 +36452,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -36504,8 +36505,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -36513,6 +36513,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -36548,7 +36549,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -36558,7 +36559,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36577,8 +36578,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -36633,7 +36633,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -36643,7 +36643,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "environments": [ @@ -36776,7 +36776,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -36787,7 +36787,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -37072,7 +37072,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37083,7 +37083,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -37215,7 +37215,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37225,7 +37225,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -37300,7 +37300,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37311,7 +37311,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", @@ -37490,7 +37490,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "environment": "production", @@ -37507,7 +37507,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -37610,7 +37610,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37622,7 +37622,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -37691,12 +37691,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37732,13 +37732,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "repos": { "total_repos": 212, @@ -37821,12 +37821,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37853,12 +37853,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37885,12 +37885,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37917,12 +37917,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37949,12 +37949,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37981,12 +37981,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38013,12 +38013,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38045,12 +38045,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38077,12 +38077,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38109,12 +38109,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38143,13 +38143,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -38210,13 +38210,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -38247,12 +38247,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38363,7 +38363,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -38372,7 +38372,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "actor_ip": "88.123.45.123", @@ -38564,7 +38564,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -38573,7 +38573,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Success", + "description": "

    Success

    ", "example": { "total_advanced_security_committers": 2, "repositories": [ @@ -38654,13 +38654,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Global", @@ -38836,7 +38836,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -38854,7 +38854,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -38911,7 +38911,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -38920,7 +38920,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -39095,7 +39095,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "events": [ @@ -39112,7 +39112,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -39167,7 +39167,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -39175,7 +39175,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39212,7 +39212,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -39220,7 +39220,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39270,7 +39270,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" @@ -39282,7 +39282,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com", "id": 1, @@ -39334,7 +39334,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -39343,7 +39343,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "queued" } @@ -39394,7 +39394,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" @@ -39406,7 +39406,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com", "login": "octocat", @@ -39490,7 +39490,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -39499,7 +39499,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "queued" } @@ -39531,13 +39531,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "seats": 1400, "seats_used": 1316, @@ -39574,13 +39574,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "running", "progress": [ @@ -39632,12 +39632,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -39664,13 +39664,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "scheduled", "scheduled_time": "Tuesday, January 22 at 15:34 -0800", @@ -39730,7 +39730,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "maintenance": "{\"enabled\":true, \"when\":\"now\"}" @@ -39739,7 +39739,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "status": "scheduled", "scheduled_time": "Tuesday, January 22 at 15:34 -0800", @@ -39788,13 +39788,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enterprise": { "private_mode": false, @@ -39972,7 +39972,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "settings": "{ \"enterprise\": { \"public_pages\": true }}" @@ -39980,7 +39980,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40007,13 +40007,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -40065,7 +40065,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" @@ -40074,7 +40074,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -40126,7 +40126,7 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" @@ -40135,7 +40135,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", @@ -40205,12 +40205,12 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40248,12 +40248,12 @@ "key": "default", "request": { "contentType": "application/x-www-form-urlencoded", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -40339,7 +40339,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -40348,7 +40348,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 42, @@ -40403,7 +40403,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -40413,7 +40413,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -40486,7 +40486,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enforcement": "enabled", @@ -40500,7 +40500,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -40553,7 +40553,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -40563,7 +40563,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -40628,7 +40628,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "github", @@ -40639,7 +40639,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -40701,7 +40701,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "the-new-octocats" @@ -40713,7 +40713,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename organization. It may take a few minutes to complete.", "url": "https:///api/v3/organizations/1" @@ -40794,13 +40794,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -40881,7 +40881,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "DevTools Hook Env", @@ -40891,7 +40891,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -40944,7 +40944,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -40953,7 +40953,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -41026,7 +41026,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -41035,7 +41035,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -41092,7 +41092,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -41100,7 +41100,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41141,7 +41141,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -41150,7 +41150,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "not_started", @@ -41197,7 +41197,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -41206,7 +41206,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "success", @@ -41289,13 +41289,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -41413,7 +41413,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Check Commits", @@ -41431,7 +41431,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -41497,7 +41497,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" @@ -41506,7 +41506,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -41632,7 +41632,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Check Commits", @@ -41648,7 +41648,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "name": "Check Commits", @@ -41714,7 +41714,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_hook_id": "PRE_RECEIVE_HOOK_ID" @@ -41722,7 +41722,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41817,7 +41817,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41827,7 +41827,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 42, @@ -41890,7 +41890,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41901,7 +41901,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -41978,7 +41978,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enforcement": "enabled" @@ -41992,7 +41992,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 42, "name": "Check Commits", @@ -42053,7 +42053,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42064,7 +42064,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Responds with effective values inherited from owner and/or global level.", + "description": "

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

    ", "example": { "id": 42, "name": "Check Commits", @@ -42156,13 +42156,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -42225,7 +42225,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_ids": "KEY_IDS" @@ -42233,7 +42233,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42279,13 +42279,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -42356,7 +42356,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "token_id": "TOKEN_ID" @@ -42364,7 +42364,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42411,7 +42411,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "monalisa", @@ -42421,7 +42421,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -42489,7 +42489,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "thenewmonalisa" @@ -42501,7 +42501,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename user. It may take a few minutes to complete.", "url": "https://api.github.com/user/1" @@ -42542,7 +42542,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -42550,7 +42550,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42601,7 +42601,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -42610,7 +42610,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when getting an existing impersonation OAuth token", + "description": "

    Response when getting an existing impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -42638,7 +42638,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -42647,7 +42647,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when creating a new impersonation OAuth token", + "description": "

    Response when creating a new impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -42709,7 +42709,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -42717,7 +42717,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42754,7 +42754,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -42762,7 +42762,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42799,7 +42799,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -42807,7 +42807,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42855,7 +42855,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -42863,7 +42863,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42911,7 +42911,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -42919,7 +42919,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -42978,13 +42978,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -43139,13 +43139,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -43232,13 +43232,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -43355,13 +43355,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -43459,7 +43459,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -43468,7 +43468,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -43598,7 +43598,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -43607,7 +43607,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -43667,7 +43667,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -43675,7 +43675,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -43742,7 +43742,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -43751,7 +43751,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", @@ -43850,7 +43850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -43859,7 +43859,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -43956,7 +43956,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -43965,7 +43965,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -44065,7 +44065,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -44073,7 +44073,7 @@ }, "response": { "statusCode": "204", - "description": "Response if gist is starred" + "description": "

    Response if gist is starred

    " } } ], @@ -44122,7 +44122,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -44130,7 +44130,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -44179,7 +44179,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -44187,7 +44187,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -44245,7 +44245,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -44255,7 +44255,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -44347,7 +44347,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -44356,7 +44356,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -44467,7 +44467,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -44476,7 +44476,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -44571,7 +44571,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -44580,7 +44580,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -44667,7 +44667,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -44677,7 +44677,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -44779,7 +44779,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -44789,7 +44789,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -44868,7 +44868,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -44877,7 +44877,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -44960,7 +44960,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "Content of the blob", @@ -44974,7 +44974,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" @@ -45049,7 +45049,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45060,7 +45060,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", "encoding": "base64", @@ -45323,7 +45323,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -45346,7 +45346,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -45444,7 +45444,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45455,7 +45455,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", @@ -45569,7 +45569,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45580,7 +45580,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/feature-a", @@ -45658,7 +45658,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45669,7 +45669,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -45760,7 +45760,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "refs/heads/featureA", @@ -45774,7 +45774,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -45865,7 +45865,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", @@ -45880,7 +45880,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -45950,7 +45950,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45960,7 +45960,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46134,7 +46134,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag": "v0.0.1", @@ -46155,7 +46155,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -46237,7 +46237,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46248,7 +46248,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -46476,7 +46476,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -46497,7 +46497,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", @@ -46589,7 +46589,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46600,7 +46600,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -46636,7 +46636,7 @@ { "key": "response-recursively-retrieving-a-tree", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46647,7 +46647,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response recursively retrieving a tree", + "description": "

    Response recursively retrieving a tree

    ", "example": { "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", @@ -46700,13 +46700,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "Actionscript", "Android", @@ -46756,7 +46756,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "name": "NAME" @@ -46765,7 +46765,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" @@ -46940,13 +46940,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -47356,7 +47356,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -47365,7 +47365,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -47794,7 +47794,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47804,7 +47804,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -48132,7 +48132,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -48153,7 +48153,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -48385,7 +48385,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -48396,7 +48396,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -48756,7 +48756,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -48779,7 +48779,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -49032,7 +49032,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49042,7 +49042,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49113,7 +49113,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49123,7 +49123,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49258,13 +49258,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -49601,7 +49601,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49611,7 +49611,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -49692,7 +49692,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -49702,7 +49702,7 @@ }, "response": { "statusCode": "204", - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned." + "description": "

    If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

    " } } ], @@ -49775,7 +49775,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -49792,7 +49792,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -50018,7 +50018,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -50035,7 +50035,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -50295,7 +50295,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50305,7 +50305,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -50401,7 +50401,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50412,7 +50412,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -50513,7 +50513,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -50527,7 +50527,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -50617,7 +50617,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50627,7 +50627,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50710,7 +50710,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50721,7 +50721,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -50828,7 +50828,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -50842,7 +50842,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -50955,7 +50955,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -50965,7 +50965,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -51192,7 +51192,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51203,7 +51203,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", @@ -51494,7 +51494,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51505,7 +51505,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -51620,7 +51620,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51631,7 +51631,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -51725,7 +51725,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -51742,7 +51742,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -51840,7 +51840,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -51857,7 +51857,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -51940,7 +51940,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51950,7 +51950,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52018,7 +52018,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52030,7 +52030,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -52113,7 +52113,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52123,7 +52123,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -52222,7 +52222,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "bug", @@ -52237,7 +52237,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -52309,7 +52309,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52320,7 +52320,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -52417,7 +52417,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "bug :bug:", @@ -52433,7 +52433,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -52497,7 +52497,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52507,7 +52507,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52580,7 +52580,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52591,7 +52591,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -52720,7 +52720,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52730,7 +52730,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", @@ -52863,7 +52863,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -52879,7 +52879,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -52979,7 +52979,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52990,7 +52990,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -53130,7 +53130,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -53147,7 +53147,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -53239,7 +53239,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -53249,7 +53249,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53328,7 +53328,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -53338,7 +53338,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53404,13 +53404,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "mit", @@ -53502,7 +53502,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "license": "LICENSE" @@ -53511,7 +53511,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "mit", "name": "MIT License", @@ -53594,7 +53594,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -53604,7 +53604,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "LICENSE", "path": "LICENSE", @@ -53697,12 +53697,12 @@ "key": "200", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53761,12 +53761,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53793,13 +53793,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "verifiable_password_authentication": true, "packages": [ @@ -53850,12 +53850,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53882,12 +53882,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -53938,7 +53938,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -53948,7 +53948,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "description": "

    Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

    ", "example": [ [ 1302998400, @@ -54009,7 +54009,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54019,7 +54019,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "days": [ @@ -54088,7 +54088,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54098,7 +54098,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "
      \n
    • w - Start of the week, given as a Unix timestamp.
    • \n
    • a - Number of additions
    • \n
    • d - Number of deletions
    • \n
    • c - Number of commits
    • \n
    ", "example": [ { "author": { @@ -54185,7 +54185,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54195,7 +54195,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The array order is oldest week (index 0) to most recent week.", + "description": "

    The array order is oldest week (index 0) to most recent week.

    ", "example": { "all": [ 11, @@ -54355,7 +54355,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -54365,7 +54365,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "description": "

    For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

    ", "example": [ [ 0, @@ -54463,7 +54463,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -54472,7 +54472,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 79, @@ -54749,7 +54749,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repositories": [ @@ -54764,7 +54764,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -54994,7 +54994,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -55004,7 +55004,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "description": "
      \n
    • pending, which means the migration hasn't started yet.
    • \n
    • exporting, which means the migration is in progress.
    • \n
    • exported, which means the migration finished successfully.
    • \n
    • failed, which means the migration failed.
    • \n
    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -55214,13 +55214,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 79, @@ -55511,13 +55511,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -55788,7 +55788,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" @@ -55797,7 +55797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -55965,13 +55965,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -56040,7 +56040,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -56049,7 +56049,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/applications/grants/1", @@ -56112,7 +56112,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" @@ -56120,7 +56120,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -56187,13 +56187,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 2, @@ -56341,13 +56341,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -56491,7 +56491,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -56500,7 +56500,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -56528,7 +56528,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" @@ -56537,7 +56537,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.4/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.4/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "description": "

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

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -56681,7 +56681,7 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -56691,7 +56691,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if returning an existing token", + "description": "

    if returning an existing token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -56719,7 +56719,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -56729,7 +56729,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response if returning a new token", + "description": "

    Response if returning a new token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -56795,7 +56795,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -56804,7 +56804,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -56949,7 +56949,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -56958,7 +56958,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -57020,7 +57020,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" @@ -57028,7 +57028,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -57090,13 +57090,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -57153,7 +57153,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -57162,7 +57162,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "github", "id": 1, @@ -57437,7 +57437,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "billing_email": "mona@github.com", @@ -57458,7 +57458,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -57628,7 +57628,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -57637,7 +57637,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "actor_ip": "88.123.45.123", @@ -57827,7 +57827,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -57836,7 +57836,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "installations": [ @@ -57938,13 +57938,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -58027,7 +58027,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -58036,7 +58036,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -58067,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", @@ -58092,7 +58092,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "organization_id": "ORGANIZATION_ID" @@ -58101,7 +58101,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response - list of custom role names", + "description": "

    Response - list of custom role names

    ", "example": { "total_count": 2, "custom_roles": [ @@ -58200,7 +58200,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -58209,7 +58209,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -58285,7 +58285,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -58294,7 +58294,7 @@ }, "response": { "statusCode": "204", - "description": "Response if requester is an organization member and user is a member" + "description": "

    Response if requester is an organization member and user is a member

    " } } ], @@ -58348,7 +58348,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -58357,7 +58357,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58407,7 +58407,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -58417,7 +58417,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -58527,7 +58527,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -58537,7 +58537,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -58631,7 +58631,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -58640,7 +58640,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58703,7 +58703,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -58712,7 +58712,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -58780,7 +58780,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -58789,7 +58789,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a public member" + "description": "

    Response if user is a public member

    " } } ], @@ -58839,7 +58839,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -58848,7 +58848,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58898,7 +58898,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -58907,7 +58907,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -58966,13 +58966,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", @@ -59107,7 +59107,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -59116,7 +59116,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", @@ -59215,7 +59215,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "active" @@ -59227,7 +59227,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -59350,7 +59350,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -59359,7 +59359,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -59427,7 +59427,7 @@ { "key": "202", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -59436,13 +59436,13 @@ }, "response": { "statusCode": "202", - "description": "User is getting converted asynchronously" + "description": "

    User is getting converted asynchronously

    " } }, { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -59451,7 +59451,7 @@ }, "response": { "statusCode": "204", - "description": "User was converted" + "description": "

    User was converted

    " } } ], @@ -59509,7 +59509,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -59518,7 +59518,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59579,7 +59579,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -59588,7 +59588,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -59864,7 +59864,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -59885,7 +59885,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -59958,7 +59958,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -59968,7 +59968,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -60209,7 +60209,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -60225,7 +60225,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -60297,7 +60297,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -60306,7 +60306,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -60356,7 +60356,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -60366,7 +60366,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -60476,7 +60476,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -60486,7 +60486,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -60556,7 +60556,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -60566,7 +60566,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -60657,7 +60657,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -60668,7 +60668,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -60774,7 +60774,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -60784,7 +60784,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -60838,7 +60838,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -60847,7 +60847,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -60900,7 +60900,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60910,7 +60910,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -61051,7 +61051,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "source": { @@ -61067,7 +61067,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -61214,7 +61214,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "cname": "octocatblog.com", @@ -61230,7 +61230,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -61284,7 +61284,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61293,7 +61293,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -61365,7 +61365,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61375,7 +61375,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", @@ -61454,7 +61454,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61464,7 +61464,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", "status": "queued" @@ -61514,7 +61514,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61524,7 +61524,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -61610,7 +61610,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61621,7 +61621,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -61726,7 +61726,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -61735,7 +61735,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -61832,7 +61832,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Organization Roadmap", @@ -61845,7 +61845,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -61936,7 +61936,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -61945,7 +61945,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -62093,7 +62093,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -62102,7 +62102,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -62197,7 +62197,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -62205,7 +62205,7 @@ }, "response": { "statusCode": "204", - "description": "Delete Success" + "description": "

    Delete Success

    " } } ], @@ -62304,7 +62304,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62314,7 +62314,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", @@ -62436,7 +62436,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Projects Documentation", @@ -62450,7 +62450,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -62560,13 +62560,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", @@ -62686,7 +62686,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -62695,7 +62695,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/users/octocat", @@ -62775,7 +62775,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -62784,7 +62784,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -62898,7 +62898,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -62907,7 +62907,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -62996,7 +62996,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -63004,7 +63004,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63084,7 +63084,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -63092,7 +63092,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63182,7 +63182,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -63191,7 +63191,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/cards/1478", @@ -63315,7 +63315,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -63324,7 +63324,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -63448,7 +63448,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -63457,7 +63457,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -63565,7 +63565,7 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -63574,7 +63574,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63640,7 +63640,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -63649,7 +63649,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63715,7 +63715,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -63725,7 +63725,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "permission": "admin", "user": { @@ -63807,7 +63807,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -63816,7 +63816,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -63893,7 +63893,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -63902,7 +63902,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -63961,7 +63961,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -63969,7 +63969,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64033,7 +64033,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -64041,7 +64041,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64112,7 +64112,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -64121,7 +64121,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/367", @@ -64196,7 +64196,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -64205,7 +64205,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -64360,7 +64360,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64370,7 +64370,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -65011,7 +65011,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Amazing new feature", @@ -65027,7 +65027,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -65623,7 +65623,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65634,7 +65634,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.4/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "

    Pass the appropriate media type to fetch diff and patch formats.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -66285,7 +66285,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "new title", @@ -66302,7 +66302,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -66916,7 +66916,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66927,7 +66927,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -67080,7 +67080,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67091,7 +67091,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", @@ -67168,7 +67168,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67178,7 +67178,7 @@ }, "response": { "statusCode": "204", - "description": "Response if pull request has been merged" + "description": "

    Response if pull request has been merged

    " } } ], @@ -67280,7 +67280,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67291,7 +67291,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if merge was successful", + "description": "

    if merge was successful

    ", "example": { "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "merged": true, @@ -67382,7 +67382,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" @@ -67396,7 +67396,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Updating pull request branch.", "url": "https://github.com/repos/octocat/Hello-World/pulls/53" @@ -67512,7 +67512,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67522,7 +67522,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -67635,7 +67635,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67646,7 +67646,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -67772,7 +67772,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "I like this too!" @@ -67786,7 +67786,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -67897,7 +67897,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -67907,7 +67907,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68021,7 +68021,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68032,7 +68032,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -68169,11 +68169,15 @@ }, { "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "description": "

    This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + }, "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, { @@ -68240,7 +68244,7 @@ "key": "example-for-a-multi-line-comment", "request": { "contentType": "application/json", - "description": "Example for a multi-line comment", + "description": "

    Example for a multi-line comment

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!", @@ -68260,7 +68264,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -68321,7 +68325,7 @@ } ], "previews": [], - "descriptionHTML": "

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    \n

    You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required.

    \n

    Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    \n

    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.

    ", + "descriptionHTML": "

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    \n

    The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

    \n

    Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    \n

    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.

    ", "statusCodes": [ { "httpStatusCode": "201", @@ -68399,7 +68403,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!" @@ -68414,7 +68418,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -68549,7 +68553,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68560,7 +68564,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "users": [ { @@ -68681,7 +68685,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -68702,7 +68706,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -69349,7 +69353,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -69369,7 +69373,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -69448,7 +69452,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69459,7 +69463,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The list of reviews returns in chronological order.", + "description": "

    The list of reviews returns in chronological order.

    ", "example": [ { "id": 80, @@ -69757,7 +69761,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", @@ -69780,7 +69784,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -69891,7 +69895,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69903,7 +69907,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -70021,7 +70025,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is close to perfect! Please address the suggested inline change. And add more about this." @@ -70036,7 +70040,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -70143,7 +70147,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70155,7 +70159,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -70284,7 +70288,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70296,7 +70300,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -70438,7 +70442,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70450,7 +70454,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -70586,7 +70590,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70598,7 +70602,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -70679,13 +70683,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "resources": { "core": { @@ -70838,7 +70842,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -70850,7 +70854,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -70963,7 +70967,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -70978,7 +70982,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "

    Response when the reaction type has already been added to this team discussion comment

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -71011,7 +71015,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -71026,7 +71030,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -71129,7 +71133,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -71141,7 +71145,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71233,7 +71237,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -71244,7 +71248,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -71348,7 +71352,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -71362,7 +71366,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -71395,7 +71399,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -71409,7 +71413,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -71503,7 +71507,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -71514,7 +71518,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71551,7 +71555,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "reaction_id": "REACTION_ID" @@ -71559,7 +71563,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -71667,7 +71671,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71678,7 +71682,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -71786,7 +71790,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -71800,7 +71804,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -71833,7 +71837,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -71847,7 +71851,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -71945,7 +71949,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71956,7 +71960,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72048,7 +72052,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72059,7 +72063,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -72167,7 +72171,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -72181,7 +72185,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -72214,7 +72218,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -72228,7 +72232,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -72326,7 +72330,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72337,7 +72341,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72429,7 +72433,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72440,7 +72444,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -72552,7 +72556,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -72566,7 +72570,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -72599,7 +72603,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -72613,7 +72617,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -72711,7 +72715,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72722,7 +72726,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72814,7 +72818,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72825,7 +72829,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -72933,7 +72937,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -72947,7 +72951,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -72980,7 +72984,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -72994,7 +72998,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -73092,7 +73096,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73103,7 +73107,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73193,7 +73197,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73204,7 +73208,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -73310,7 +73314,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -73324,7 +73328,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -73357,7 +73361,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -73371,7 +73375,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -73469,7 +73473,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73480,7 +73484,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73572,7 +73576,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -73583,7 +73587,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -73687,7 +73691,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -73701,7 +73705,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -73810,7 +73814,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -73820,7 +73824,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -73915,7 +73919,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -73928,7 +73932,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -73978,6 +73982,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74022,7 +74027,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74032,7 +74037,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", @@ -74123,8 +74128,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74132,6 +74136,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74226,7 +74231,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -74245,7 +74250,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -74335,8 +74340,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74344,6 +74348,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", "title": "Generate release notes content for a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74408,7 +74413,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -74424,7 +74429,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Name and body of generated release notes", + "description": "

    Name and body of generated release notes

    ", "example": { "name": "Release v1.0.0 is now available!", "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa" @@ -74443,8 +74448,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74452,6 +74456,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74478,7 +74483,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74488,7 +74493,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -74574,8 +74579,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74583,6 +74587,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74619,7 +74624,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74630,7 +74635,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -74720,8 +74725,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74729,6 +74733,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74764,7 +74769,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74775,7 +74780,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#hypermedia).", + "description": "

    Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -74865,8 +74870,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74874,6 +74878,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74965,7 +74970,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -74984,7 +74989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -75070,8 +75075,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -75079,6 +75083,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -75114,7 +75119,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -75124,7 +75129,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75135,8 +75140,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ @@ -75182,7 +75186,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -75193,7 +75197,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.4/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "

    To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -75321,7 +75325,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "foo-1.0.0-osx.zip", @@ -75336,7 +75340,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -75425,7 +75429,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -75435,7 +75439,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75508,7 +75512,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -75519,7 +75523,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", @@ -75628,7 +75632,7 @@ "key": "default", "request": { "contentType": "*/*", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -75639,7 +75643,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for successful upload", + "description": "

    Response for successful upload

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -75782,7 +75786,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -75791,7 +75795,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -76114,7 +76118,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -76132,7 +76136,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -76310,7 +76314,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -76320,7 +76324,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -77349,7 +77353,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -77368,7 +77372,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -77939,7 +77943,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -77948,7 +77952,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -78033,7 +78037,7 @@ { "key": "response-if-repository-contains-content", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78043,7 +78047,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if repository contains content", + "description": "

    if repository contains content

    ", "example": [ { "login": "octocat", @@ -78148,7 +78152,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "event_type": "on-demand-test", @@ -78164,7 +78168,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -78214,7 +78218,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78224,7 +78228,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "C": 78769, "Python": 7769 @@ -78292,7 +78296,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78302,7 +78306,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Status information for cache replicas", + "description": "

    Status information for cache replicas

    ", "example": [ { "host": "host-1", @@ -78400,7 +78404,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78410,7 +78414,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "v0.1", @@ -78486,7 +78490,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78496,7 +78500,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -78576,7 +78580,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -78586,7 +78590,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -78658,7 +78662,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "names": [ @@ -78676,7 +78680,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -78761,7 +78765,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_owner": "github", @@ -78778,7 +78782,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -79099,7 +79103,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "owner": "octocat", @@ -79116,7 +79120,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -79288,13 +79292,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -79510,13 +79514,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -79899,13 +79903,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -80152,7 +80156,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -80161,7 +80165,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -80325,7 +80329,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80335,7 +80339,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -80408,7 +80412,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", @@ -80422,7 +80426,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "response", + "description": "

    response

    ", "example": { "id": 1, "key_prefix": "TICKET-", @@ -80486,7 +80490,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80497,7 +80501,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key_prefix": "TICKET-", @@ -80561,7 +80565,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80571,7 +80575,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80642,7 +80646,7 @@ { "key": "response-if-content-is-a-file", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80653,7 +80657,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a file", + "description": "

    Response if content is a file

    ", "example": { "type": "file", "encoding": "base64", @@ -80677,7 +80681,7 @@ { "key": "response-if-content-is-a-directory", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80688,7 +80692,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a directory", + "description": "

    Response if content is a directory

    ", "example": [ { "type": "file", @@ -80728,7 +80732,7 @@ { "key": "response-if-content-is-a-symlink", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80739,7 +80743,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a symlink", + "description": "

    Response if content is a symlink

    ", "example": { "type": "symlink", "target": "/path/to/symlink/target", @@ -80762,7 +80766,7 @@ { "key": "response-if-content-is-a-submodule", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -80773,7 +80777,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a submodule", + "description": "

    Response if content is a submodule

    ", "example": { "type": "submodule", "submodule_git_url": "git://github.com/jquery/qunit.git", @@ -81058,7 +81062,7 @@ "key": "example-for-creating-a-file", "request": { "contentType": "application/json", - "description": "Example for creating a file", + "description": "

    Example for creating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -81077,7 +81081,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -81136,7 +81140,7 @@ "key": "example-for-updating-a-file", "request": { "contentType": "application/json", - "description": "Example for updating a file", + "description": "

    Example for updating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "a new commit message", @@ -81156,7 +81160,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -81419,7 +81423,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -81438,7 +81442,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": null, "commit": { @@ -81546,7 +81550,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -81556,7 +81560,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -81647,7 +81651,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -81658,7 +81662,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -81739,7 +81743,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -81749,7 +81753,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81804,7 +81808,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -81814,7 +81818,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81896,7 +81900,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -81906,7 +81910,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -82083,7 +82087,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -82093,7 +82097,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -82666,7 +82670,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -82675,7 +82679,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -82725,7 +82729,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -82734,7 +82738,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82818,13 +82822,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 7, "incomplete_results": false, @@ -83004,13 +83008,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "incomplete_results": false, @@ -83233,13 +83237,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 280, "incomplete_results": false, @@ -83446,13 +83450,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "incomplete_results": false, @@ -83578,13 +83582,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 40, "incomplete_results": false, @@ -83761,13 +83765,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 6, "incomplete_results": false, @@ -83938,13 +83942,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 12, "incomplete_results": false, @@ -84082,7 +84086,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -84091,7 +84095,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -84680,7 +84684,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -84689,7 +84693,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -85287,7 +85291,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85297,7 +85301,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -85407,7 +85411,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85418,7 +85422,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -85531,7 +85535,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "resolved", @@ -85546,7 +85550,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -85665,7 +85669,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85676,7 +85680,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "commit", @@ -85787,7 +85791,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -85796,7 +85800,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -85942,7 +85946,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Justice League", @@ -85957,7 +85961,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -86058,7 +86062,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86068,7 +86072,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -86225,7 +86229,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -86240,7 +86244,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -86333,7 +86337,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86342,7 +86346,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -86406,7 +86410,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86416,7 +86420,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -86514,7 +86518,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86525,7 +86529,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -86641,7 +86645,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86651,7 +86655,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -86710,7 +86714,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86720,7 +86724,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -86784,7 +86788,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86794,7 +86798,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -86964,7 +86968,7 @@ { "key": "alternative-response-with-repository-permissions", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -86976,7 +86980,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with repository permissions", + "description": "

    Alternative response with repository permissions

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -87314,7 +87318,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -87325,7 +87329,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87389,7 +87393,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -87400,7 +87404,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87464,7 +87468,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -87474,7 +87478,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -87539,7 +87543,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -87548,7 +87552,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -87696,7 +87700,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -87710,7 +87714,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the updated information already exists", + "description": "

    Response when the updated information already exists

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -87764,7 +87768,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -87778,7 +87782,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -87878,7 +87882,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -87886,7 +87890,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -87949,7 +87953,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -87958,7 +87962,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -88051,7 +88055,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -88061,7 +88065,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -88168,7 +88172,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -88177,7 +88181,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88235,7 +88239,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -88244,7 +88248,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88307,7 +88311,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -88316,7 +88320,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -88481,7 +88485,7 @@ { "key": "alternative-response-with-extra-repository-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -88492,7 +88496,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with extra repository information", + "description": "

    Alternative response with extra repository information

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -88818,7 +88822,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -88828,7 +88832,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88891,7 +88895,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -88901,7 +88905,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -88956,7 +88960,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -88965,7 +88969,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -89051,13 +89055,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -89208,7 +89212,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -89219,7 +89223,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -89332,7 +89336,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -89346,7 +89350,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -89455,7 +89459,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -89467,7 +89471,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -89587,7 +89591,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -89602,7 +89606,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -89711,7 +89715,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -89722,7 +89726,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -89800,7 +89804,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -89810,7 +89814,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -89914,7 +89918,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -89927,7 +89931,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -90027,7 +90031,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -90038,7 +90042,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -90149,7 +90153,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -90163,7 +90167,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -90263,7 +90267,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -90273,7 +90277,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -90362,7 +90366,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -90372,7 +90376,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -90500,7 +90504,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -90514,7 +90518,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -90619,7 +90623,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -90630,7 +90634,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -90755,7 +90759,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -90769,7 +90773,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -90874,7 +90878,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -90884,7 +90888,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -90953,7 +90957,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -90962,7 +90966,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -91081,7 +91085,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -91094,7 +91098,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -91190,7 +91194,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -91200,7 +91204,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -91316,7 +91320,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -91329,7 +91333,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -91425,7 +91429,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -91434,7 +91438,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -91515,7 +91519,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -91525,7 +91529,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -91602,7 +91606,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -91613,7 +91617,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -91693,7 +91697,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -91704,7 +91708,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -91772,7 +91776,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -91782,7 +91786,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -91856,7 +91860,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -91865,7 +91869,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -91937,7 +91941,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -91946,7 +91950,7 @@ }, "response": { "statusCode": "204", - "description": "if user is a member" + "description": "

    if user is a member

    " } } ], @@ -91996,7 +92000,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -92005,7 +92009,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -92063,7 +92067,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -92072,7 +92076,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -92122,7 +92126,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -92132,7 +92136,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -92203,7 +92207,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -92213,7 +92217,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -92276,7 +92280,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -92285,7 +92289,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -92319,13 +92323,13 @@ { "key": "response-with-public-and-private-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public and private profile information", + "description": "

    Response with public and private profile information

    ", "example": { "login": "octocat", "id": 1, @@ -92376,13 +92380,13 @@ { "key": "response-with-public-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public profile information", + "description": "

    Response with public profile information

    ", "example": { "login": "octocat", "id": 1, @@ -92549,13 +92553,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -92666,13 +92670,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -92735,7 +92739,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -92744,7 +92748,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "octocat", "id": 1, @@ -92784,7 +92788,7 @@ { "key": "response-with-git-hub-plan-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -92793,7 +92797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with GitHub plan information", + "description": "

    Response with GitHub plan information

    ", "example": { "login": "octocat", "id": 1, @@ -92898,7 +92902,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -92907,7 +92911,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "contexts": [ { @@ -92972,13 +92976,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -93048,13 +93052,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@octocat.org", @@ -93139,12 +93143,12 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -93210,13 +93214,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "email": "octocat@github.com", @@ -93288,13 +93292,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -93374,13 +93378,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -93451,7 +93455,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -93459,7 +93463,7 @@ }, "response": { "statusCode": "204", - "description": "if the person is followed by the authenticated user" + "description": "

    if the person is followed by the authenticated user

    " } } ], @@ -93512,7 +93516,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -93520,7 +93524,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -93573,7 +93577,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -93581,7 +93585,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -93652,7 +93656,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -93661,7 +93665,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -93738,7 +93742,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -93747,7 +93751,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -93815,7 +93819,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -93824,7 +93828,7 @@ }, "response": { "statusCode": "204", - "description": "if the user follows the target user" + "description": "

    if the user follows the target user

    " } } ], @@ -93876,13 +93880,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -93973,13 +93977,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -94071,7 +94075,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -94080,7 +94084,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -94168,7 +94172,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -94176,7 +94180,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -94251,7 +94255,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -94260,7 +94264,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -94345,13 +94349,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -94438,13 +94442,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -94510,7 +94514,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -94519,7 +94523,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -94581,7 +94585,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -94589,7 +94593,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -94660,7 +94664,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -94669,7 +94673,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -94734,7 +94738,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -94745,7 +94749,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -94864,7 +94868,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -94875,7 +94879,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -94956,7 +94960,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -94967,7 +94971,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -95067,7 +95071,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -95079,7 +95083,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -95194,7 +95198,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -95205,7 +95209,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -95279,7 +95283,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -95289,7 +95293,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Repository", @@ -95578,7 +95582,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -95601,7 +95605,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -95694,7 +95698,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -95705,7 +95709,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -96019,7 +96023,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -96036,7 +96040,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -96125,7 +96129,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -96135,7 +96139,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -96194,7 +96198,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -96204,7 +96208,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -96263,7 +96267,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -96273,7 +96277,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index bdddd6305a..d6c9fc59fd 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -52,7 +52,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62,7 +62,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -146,7 +146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -157,7 +157,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 11, "node_id": "MDg6QXJ0aWZhY3QxMQ==", @@ -224,7 +224,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -234,7 +234,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -298,7 +298,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -309,7 +309,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -382,7 +382,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -393,7 +393,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "artifacts": [ @@ -461,7 +461,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -470,7 +470,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_organizations": "all", "allowed_actions": "selected", @@ -542,7 +542,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_organizations": "all", @@ -554,7 +554,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -609,7 +609,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -618,7 +618,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "organizations": [ @@ -689,7 +689,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_organization_ids": [ @@ -703,7 +703,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -749,7 +749,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -758,7 +758,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -804,7 +804,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -813,7 +813,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -850,7 +850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -859,7 +859,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -936,7 +936,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -952,7 +952,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -989,7 +989,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -998,7 +998,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled_repositories": "all", "allowed_actions": "selected", @@ -1070,7 +1070,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled_repositories": "all", @@ -1082,7 +1082,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1137,7 +1137,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1146,7 +1146,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -1326,7 +1326,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -1340,7 +1340,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1386,7 +1386,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1395,7 +1395,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1441,7 +1441,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -1450,7 +1450,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1487,7 +1487,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1496,7 +1496,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1573,7 +1573,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1589,7 +1589,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1635,7 +1635,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1645,7 +1645,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "enabled": true, "allowed_actions": "selected", @@ -1721,7 +1721,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "enabled": true, @@ -1734,7 +1734,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1780,7 +1780,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -1790,7 +1790,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "github_owned_allowed": true, "verified_allowed": false, @@ -1876,7 +1876,7 @@ "key": "selected_actions", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "github_owned_allowed": true, @@ -1893,7 +1893,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -1950,7 +1950,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -1959,7 +1959,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "secrets": [ @@ -2020,7 +2020,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -2029,7 +2029,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2079,7 +2079,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2089,7 +2089,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2189,7 +2189,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2207,14 +2207,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2232,7 +2232,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -2282,7 +2282,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2291,7 +2291,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2355,7 +2355,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2365,7 +2365,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -2499,7 +2499,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ @@ -2513,7 +2513,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -2568,7 +2568,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2578,7 +2578,7 @@ }, "response": { "statusCode": "204", - "description": "No Content when repository was added to the selected list" + "description": "

    No Content when repository was added to the selected list

    " } } ], @@ -2637,7 +2637,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -2647,7 +2647,7 @@ }, "response": { "statusCode": "204", - "description": "Response when repository was removed from the selected list" + "description": "

    Response when repository was removed from the selected list

    " } } ], @@ -2715,7 +2715,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2725,7 +2725,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "secrets": [ @@ -2786,7 +2786,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2796,7 +2796,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" @@ -2855,7 +2855,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -2866,7 +2866,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", @@ -2947,7 +2947,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2961,14 +2961,14 @@ }, "response": { "statusCode": "201", - "description": "Response when creating a secret" + "description": "

    Response when creating a secret

    " } }, { "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", @@ -2982,7 +2982,7 @@ }, "response": { "statusCode": "204", - "description": "Response when updating a secret" + "description": "

    Response when updating a secret

    " } } ], @@ -3041,7 +3041,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -3051,7 +3051,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3108,7 +3108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -3117,7 +3117,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -3244,7 +3244,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3265,7 +3265,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3320,7 +3320,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3330,7 +3330,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -3420,7 +3420,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -3434,7 +3434,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "Expensive hardware runners", @@ -3489,7 +3489,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3498,7 +3498,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3562,7 +3562,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3572,7 +3572,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -3691,7 +3691,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "runners": [ @@ -3706,7 +3706,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3761,7 +3761,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3771,7 +3771,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3826,7 +3826,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -3836,7 +3836,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -3891,7 +3891,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -3900,7 +3900,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 3, "runner_groups": [ @@ -4032,7 +4032,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4053,7 +4053,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4109,7 +4109,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4119,7 +4119,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4210,7 +4210,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Expensive hardware runners", @@ -4224,7 +4224,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "octo-runner-group", @@ -4280,7 +4280,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4289,7 +4289,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4344,7 +4344,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -4354,7 +4354,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4411,7 +4411,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -4420,7 +4420,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -4515,7 +4515,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -4524,7 +4524,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -4593,7 +4593,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -4602,7 +4602,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -4643,7 +4643,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -4652,7 +4652,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -4702,7 +4702,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4712,7 +4712,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -4787,7 +4787,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -4796,7 +4796,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -4851,7 +4851,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -4860,7 +4860,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -4955,7 +4955,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -4964,7 +4964,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -5033,7 +5033,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -5042,7 +5042,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -5083,7 +5083,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -5092,7 +5092,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -5142,7 +5142,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5152,7 +5152,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -5227,7 +5227,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -5236,7 +5236,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5300,7 +5300,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -5310,7 +5310,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "runners": [ @@ -5414,7 +5414,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -5424,7 +5424,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "os": "osx", @@ -5502,7 +5502,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -5512,7 +5512,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" @@ -5562,7 +5562,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -5572,7 +5572,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" @@ -5631,7 +5631,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -5642,7 +5642,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 23, "name": "MBP", @@ -5726,7 +5726,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -5736,7 +5736,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -5793,7 +5793,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -5804,7 +5804,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 399444496, "run_id": 29679449, @@ -5965,7 +5965,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -5975,7 +5975,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -6057,7 +6057,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6069,7 +6069,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "jobs": [ @@ -6271,7 +6271,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6282,7 +6282,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "jobs": [ @@ -6530,7 +6530,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6540,7 +6540,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -6828,7 +6828,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -6839,7 +6839,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 30433642, "name": "Build", @@ -7112,7 +7112,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7122,7 +7122,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7196,7 +7196,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7208,7 +7208,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 30433642, "name": "Build", @@ -7490,7 +7490,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7501,7 +7501,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7556,7 +7556,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7566,7 +7566,7 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7625,7 +7625,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7635,7 +7635,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7690,7 +7690,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7700,7 +7700,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7763,7 +7763,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7773,7 +7773,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -7828,7 +7828,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -7839,7 +7839,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "billable": { "UBUNTU": { @@ -8041,7 +8041,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8052,7 +8052,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "workflow_runs": [ @@ -8341,7 +8341,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8351,7 +8351,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "workflows": [ @@ -8442,7 +8442,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8453,7 +8453,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161335, "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", @@ -8527,7 +8527,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8537,7 +8537,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8623,7 +8623,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -8640,7 +8640,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8702,7 +8702,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8712,7 +8712,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8774,7 +8774,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8785,7 +8785,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "billable": { "UBUNTU": { @@ -8866,7 +8866,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -8875,7 +8875,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -8930,7 +8930,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -8938,7 +8938,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9002,7 +9002,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -9011,7 +9011,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9040,13 +9040,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", @@ -9182,13 +9182,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -9338,24 +9338,24 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -9408,7 +9408,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -9417,7 +9417,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": "1", "repository": { @@ -9550,7 +9550,7 @@ { "key": "205", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -9558,7 +9558,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -9603,7 +9603,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -9612,7 +9612,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -9681,7 +9681,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -9690,7 +9690,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -9747,7 +9747,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "thread_id": "THREAD_ID" @@ -9755,7 +9755,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -9871,7 +9871,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -9881,7 +9881,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": "1", @@ -10025,7 +10025,7 @@ "key": "202", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10034,14 +10034,14 @@ }, "response": { "statusCode": "202", - "description": "Response" + "description": "

    Response

    " } }, { "key": "205", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10050,7 +10050,7 @@ }, "response": { "statusCode": "205", - "description": "Reset Content" + "description": "

    Reset Content

    " } } ], @@ -10120,7 +10120,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10130,7 +10130,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "login": "octocat", @@ -10158,7 +10158,7 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10168,7 +10168,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -10271,13 +10271,13 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -10408,13 +10408,13 @@ { "key": "alternative-response-with-star-creation-timestamps", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/vnd.github.v3.star+json", - "description": "Alternative response with star creation timestamps", + "description": "

    Alternative response with star creation timestamps

    ", "example": [ { "starred_at": "2011-01-16T19:06:43Z", @@ -10600,7 +10600,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10609,7 +10609,7 @@ }, "response": { "statusCode": "204", - "description": "Response if this repository is starred by you" + "description": "

    Response if this repository is starred by you

    " } } ], @@ -10671,7 +10671,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10680,7 +10680,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10742,7 +10742,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -10751,7 +10751,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -10850,7 +10850,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -10859,7 +10859,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -11050,7 +11050,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11060,7 +11060,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -11128,7 +11128,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11138,7 +11138,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if you subscribe to the repository", + "description": "

    if you subscribe to the repository

    ", "example": { "subscribed": true, "ignored": false, @@ -11220,7 +11220,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11230,7 +11230,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "subscribed": true, "ignored": false, @@ -11284,7 +11284,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -11293,7 +11293,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -11339,13 +11339,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -11518,7 +11518,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -11527,7 +11527,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -11663,13 +11663,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -11747,7 +11747,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "code": "CODE" @@ -11756,7 +11756,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -11874,13 +11874,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "The permissions the installation has are included under the `permissions` key.", + "description": "

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

    ", "example": [ { "id": 1, @@ -11974,7 +11974,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -11983,7 +11983,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -12079,7 +12079,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -12087,7 +12087,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -12971,7 +12971,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "respoitory": "Hello-World", @@ -12987,7 +12987,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", @@ -13179,7 +13179,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -13187,7 +13187,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13233,7 +13233,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -13241,7 +13241,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13282,7 +13282,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "app_slug": "APP_SLUG" @@ -13291,7 +13291,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "slug": "octoapp", @@ -13377,7 +13377,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -13386,7 +13386,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -13482,7 +13482,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -13492,7 +13492,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -13587,7 +13587,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -13596,7 +13596,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "account": { @@ -13695,13 +13695,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "repositories": [ @@ -13863,12 +13863,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -13914,13 +13914,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "You can find the permissions for the installation under the `permissions` key.", + "description": "

    You can find the permissions for the installation under the permissions key.

    ", "example": { "total_count": 2, "installations": [ @@ -14097,7 +14097,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1 @@ -14106,7 +14106,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "description": "

    The access the user has to each repository is included in the hash under the permissions key.

    ", "example": { "total_count": 1, "repositories": [ @@ -14297,7 +14297,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -14306,7 +14306,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14369,7 +14369,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "installation_id": 1, @@ -14378,7 +14378,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14445,7 +14445,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -14456,7 +14456,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14513,7 +14513,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -14525,7 +14525,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -14628,7 +14628,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -14640,7 +14640,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -14739,7 +14739,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -14750,7 +14750,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -14805,7 +14805,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", @@ -14815,7 +14815,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -14886,13 +14886,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -14983,7 +14983,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content_type": "json", @@ -14995,7 +14995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -15047,13 +15047,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -15126,7 +15126,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -15135,7 +15135,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -15222,7 +15222,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "delivery_id": "DELIVERY_ID" @@ -15230,7 +15230,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -15261,6 +15261,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -15314,7 +15315,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15324,7 +15325,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "master", @@ -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", @@ -15404,7 +15405,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15414,7 +15415,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -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", @@ -15479,7 +15480,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "branch": "main" @@ -15492,7 +15493,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The branch has been successfully synced with the upstream repository", + "description": "

    The branch has been successfully synced with the upstream repository

    ", "example": { "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", "merge_type": "fast-forward", @@ -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", @@ -15580,7 +15581,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base": "master", @@ -15595,7 +15596,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Successful Response (The resulting merge commit)", + "description": "

    Successful Response (The resulting merge commit)

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -15721,8 +15722,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -15769,7 +15769,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -15780,7 +15780,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", "required_status_checks": { @@ -16780,7 +16780,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "required_status_checks": { @@ -16836,7 +16836,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16904,7 +16904,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -16914,7 +16914,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -16974,7 +16974,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -16985,7 +16985,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -17045,7 +17045,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17056,7 +17056,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", "enabled": true @@ -17116,7 +17116,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17126,7 +17126,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17186,7 +17186,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17197,7 +17197,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -17465,7 +17465,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "dismissal_restrictions": { @@ -17497,7 +17497,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { @@ -17606,7 +17606,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17616,7 +17616,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17676,7 +17676,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17687,7 +17687,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -17751,7 +17751,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17762,7 +17762,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", "enabled": true @@ -17826,7 +17826,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17836,7 +17836,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -17896,7 +17896,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -17907,7 +17907,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -18060,7 +18060,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "strict": true, @@ -18077,7 +18077,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", "strict": true, @@ -18149,7 +18149,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18159,7 +18159,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -18215,7 +18215,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18226,7 +18226,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -18303,7 +18303,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18314,7 +18314,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci", "continuous-integration/jenkins" @@ -18400,7 +18400,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18411,7 +18411,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -18492,7 +18492,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18503,7 +18503,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "continuous-integration/travis-ci" ] @@ -18570,7 +18570,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18581,7 +18581,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", @@ -18722,7 +18722,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18732,7 +18732,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -18788,7 +18788,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18799,7 +18799,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -18916,7 +18916,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -18927,7 +18927,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -19044,7 +19044,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19055,7 +19055,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -19172,7 +19172,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19183,7 +19183,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -19286,7 +19286,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19297,7 +19297,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -19387,7 +19387,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19398,7 +19398,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -19488,7 +19488,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19499,7 +19499,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -19589,7 +19589,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19600,7 +19600,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -19676,7 +19676,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19687,7 +19687,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -19783,7 +19783,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19794,7 +19794,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -19890,7 +19890,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -19901,7 +19901,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -19997,7 +19997,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -20008,7 +20008,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -21036,7 +21036,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Example of an in_progress conclusion", + "description": "

    Example of an in_progress conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -21058,7 +21058,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "

    Response for in_progress conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -21155,7 +21155,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Example of a completed conclusion", + "description": "

    Example of a completed conclusion

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -21211,7 +21211,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "

    Response for completed conclusion

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -21356,7 +21356,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -21367,7 +21367,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -22453,7 +22453,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -22502,7 +22502,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -22665,7 +22665,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22676,7 +22676,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "path": "README.md", @@ -22745,7 +22745,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22755,7 +22755,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -22877,7 +22877,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -22888,7 +22888,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -23103,7 +23103,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -23114,7 +23114,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_runs": [ @@ -23268,7 +23268,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -23281,7 +23281,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the suite already exists", + "description": "

    Response when the suite already exists

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -23588,7 +23588,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" @@ -23601,7 +23601,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when the suite was created", + "description": "

    Response when the suite was created

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -24017,7 +24017,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "auto_trigger_checks": [ @@ -24035,7 +24035,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "preferences": { "auto_trigger_checks": [ @@ -24329,7 +24329,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24340,7 +24340,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 5, "node_id": "MDEwOkNoZWNrU3VpdGU1", @@ -24695,7 +24695,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24705,7 +24705,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -24798,7 +24798,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -24809,7 +24809,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "check_suites": [ @@ -25108,7 +25108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25118,7 +25118,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 4, @@ -25290,7 +25290,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25301,7 +25301,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-06-19T11:21:34Z", @@ -25471,7 +25471,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", @@ -25487,7 +25487,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-08-25T21:28:36Z", @@ -25652,7 +25652,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25663,7 +25663,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -25828,7 +25828,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25838,7 +25838,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/main", @@ -25949,7 +25949,7 @@ { "key": "response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -25960,7 +25960,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "ref": "refs/heads/main", "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", @@ -26060,7 +26060,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26071,7 +26071,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" @@ -26201,7 +26201,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26211,7 +26211,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -26290,7 +26290,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26301,7 +26301,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "processing_status": "complete", "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" @@ -26348,13 +26348,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "citizen_code_of_conduct", @@ -26409,7 +26409,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key": "KEY" @@ -26418,7 +26418,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "contributor_covenant", "name": "Contributor Covenant", @@ -26457,6 +26457,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -26516,7 +26517,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26526,7 +26527,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -26571,8 +26572,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -26580,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", @@ -26615,7 +26616,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26625,7 +26626,7 @@ }, "response": { "statusCode": "204", - "description": "Response if user is a collaborator" + "description": "

    Response if user is a collaborator

    " } } ], @@ -26640,8 +26641,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -26649,6 +26649,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -26714,7 +26715,7 @@ "key": "response-when-a-new-invitation-is-created", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26725,7 +26726,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when a new invitation is created", + "description": "

    Response when a new invitation is created

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -26865,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", @@ -26874,6 +26874,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -26909,7 +26910,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26919,7 +26920,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -26930,8 +26931,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -26939,6 +26939,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -26974,7 +26975,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -26985,7 +26986,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if user has admin permissions", + "description": "

    if user has admin permissions

    ", "example": { "permission": "admin", "role_name": "admin", @@ -27024,8 +27025,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -27080,7 +27080,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27090,7 +27090,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -27282,7 +27282,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27293,7 +27293,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -27466,7 +27466,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27476,7 +27476,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -27522,13 +27522,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -27700,7 +27700,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -27708,7 +27708,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -27761,7 +27761,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" @@ -27769,7 +27769,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -27808,6 +27808,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -27899,7 +27900,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -27909,7 +27910,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -28016,8 +28017,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -28025,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", @@ -28061,7 +28062,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28072,7 +28073,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "branch_5", @@ -28097,8 +28098,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -28106,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", @@ -28160,7 +28161,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28171,7 +28172,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -28702,8 +28703,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -28711,6 +28711,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -28765,7 +28766,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28776,7 +28777,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -28894,8 +28895,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -28903,6 +28903,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -28956,7 +28957,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -28967,7 +28968,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", @@ -29247,8 +29248,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -29303,7 +29303,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29313,7 +29313,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -29404,7 +29404,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29415,7 +29415,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -29519,7 +29519,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Nice change" @@ -29533,7 +29533,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -29626,7 +29626,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29636,7 +29636,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -29714,7 +29714,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -29725,7 +29725,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", @@ -29855,7 +29855,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff", @@ -29872,7 +29872,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", @@ -29990,7 +29990,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30001,7 +30001,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "state": "success", "statuses": [ @@ -30181,7 +30181,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30192,7 +30192,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -30331,7 +30331,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "success", @@ -30348,7 +30348,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", @@ -30395,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", @@ -30448,7 +30447,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30458,7 +30457,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -30480,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", @@ -30544,7 +30543,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "octocat@octomac", @@ -30559,7 +30558,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -30583,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", @@ -30627,7 +30626,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30638,7 +30637,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key": "ssh-rsa AAA...", @@ -30662,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", @@ -30706,7 +30705,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30716,7 +30715,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -30727,7 +30726,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -30739,6 +30739,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -30826,7 +30827,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -30836,7 +30837,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -30887,8 +30888,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -30896,6 +30896,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -31025,7 +31026,7 @@ "key": "simple-example", "request": { "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "topic-branch", @@ -31040,7 +31041,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Simple example", + "description": "

    Simple example

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -31101,8 +31102,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -31110,6 +31110,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -31145,7 +31146,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31156,7 +31157,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, @@ -31209,8 +31210,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -31218,6 +31218,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -31253,7 +31254,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31263,7 +31264,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -31282,8 +31283,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -31338,7 +31338,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31348,7 +31348,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "environments": [ @@ -31481,7 +31481,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31492,7 +31492,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -31777,7 +31777,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31788,7 +31788,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", @@ -31920,7 +31920,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -31930,7 +31930,7 @@ }, "response": { "statusCode": "204", - "description": "Default response" + "description": "

    Default response

    " } } ], @@ -32005,7 +32005,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32016,7 +32016,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", @@ -32195,7 +32195,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "environment": "production", @@ -32212,7 +32212,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -32315,7 +32315,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -32327,7 +32327,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, @@ -32396,12 +32396,12 @@ { "key": "200", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32437,13 +32437,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "repos": { "total_repos": 212, @@ -32526,12 +32526,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32558,12 +32558,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32590,12 +32590,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32622,12 +32622,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32654,12 +32654,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32686,12 +32686,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32718,12 +32718,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32750,12 +32750,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32782,12 +32782,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32814,12 +32814,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -32848,13 +32848,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -32915,13 +32915,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" @@ -32952,12 +32952,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33005,13 +33005,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Global", @@ -33187,7 +33187,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -33205,7 +33205,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -33262,7 +33262,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -33271,7 +33271,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -33446,7 +33446,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "events": [ @@ -33463,7 +33463,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Global", "id": 1, @@ -33518,7 +33518,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -33526,7 +33526,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33563,7 +33563,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "hook_id": "HOOK_ID" @@ -33571,7 +33571,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -33600,13 +33600,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "seats": 1400, "seats_used": 1316, @@ -33672,7 +33672,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "github", @@ -33683,7 +33683,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -33745,7 +33745,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "login": "the-new-octocats" @@ -33757,7 +33757,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Job queued to rename organization. It may take a few minutes to complete.", "url": "https:///api/v3/organizations/1" @@ -33838,13 +33838,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -33925,7 +33925,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "DevTools Hook Env", @@ -33935,7 +33935,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -33988,7 +33988,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -33997,7 +33997,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -34070,7 +34070,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -34079,7 +34079,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 2, "name": "DevTools Hook Env", @@ -34136,7 +34136,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -34144,7 +34144,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -34185,7 +34185,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -34194,7 +34194,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "not_started", @@ -34241,7 +34241,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "pre_receive_environment_id": "PRE_RECEIVE_ENVIRONMENT_ID" @@ -34250,7 +34250,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest", "state": "success", @@ -34331,7 +34331,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" @@ -34340,7 +34340,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" @@ -34499,7 +34499,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -34522,7 +34522,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -34603,7 +34603,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -34613,7 +34613,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -34750,7 +34750,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -34774,7 +34774,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -34950,7 +34950,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ @@ -34976,7 +34976,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -35043,7 +35043,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", @@ -35052,7 +35052,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35138,13 +35138,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -35207,7 +35207,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_ids": "KEY_IDS" @@ -35215,7 +35215,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35261,13 +35261,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -35327,7 +35327,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "token_id": "TOKEN_ID" @@ -35335,7 +35335,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35372,7 +35372,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -35380,7 +35380,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35431,7 +35431,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -35440,7 +35440,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when getting an existing impersonation OAuth token", + "description": "

    Response when getting an existing impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -35468,7 +35468,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -35477,7 +35477,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response when creating a new impersonation OAuth token", + "description": "

    Response when creating a new impersonation OAuth token

    ", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -35539,7 +35539,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -35547,7 +35547,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35595,7 +35595,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -35603,7 +35603,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35651,7 +35651,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -35659,7 +35659,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -35718,13 +35718,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -35879,13 +35879,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -35972,13 +35972,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -36095,13 +36095,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -36199,7 +36199,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36208,7 +36208,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -36338,7 +36338,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36347,7 +36347,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -36407,7 +36407,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36415,7 +36415,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36482,7 +36482,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36491,7 +36491,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", @@ -36590,7 +36590,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36599,7 +36599,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -36696,7 +36696,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36705,7 +36705,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -36805,7 +36805,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36813,7 +36813,7 @@ }, "response": { "statusCode": "204", - "description": "Response if gist is starred" + "description": "

    Response if gist is starred

    " } } ], @@ -36862,7 +36862,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36870,7 +36870,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36919,7 +36919,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -36927,7 +36927,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -36985,7 +36985,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -36995,7 +36995,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", @@ -37087,7 +37087,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -37096,7 +37096,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", @@ -37207,7 +37207,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -37216,7 +37216,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -37311,7 +37311,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" @@ -37320,7 +37320,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -37407,7 +37407,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -37417,7 +37417,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -37519,7 +37519,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -37529,7 +37529,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", @@ -37608,7 +37608,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", @@ -37617,7 +37617,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -37700,7 +37700,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "Content of the blob", @@ -37714,7 +37714,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" @@ -37789,7 +37789,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -37800,7 +37800,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", "encoding": "base64", @@ -38063,7 +38063,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -38086,7 +38086,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -38184,7 +38184,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38195,7 +38195,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", @@ -38309,7 +38309,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38320,7 +38320,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "ref": "refs/heads/feature-a", @@ -38398,7 +38398,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38409,7 +38409,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -38500,7 +38500,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "refs/heads/featureA", @@ -38514,7 +38514,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -38605,7 +38605,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", @@ -38620,7 +38620,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", @@ -38690,7 +38690,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38700,7 +38700,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -38874,7 +38874,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag": "v0.0.1", @@ -38895,7 +38895,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -38977,7 +38977,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -38988,7 +38988,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", @@ -39216,7 +39216,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -39237,7 +39237,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", @@ -39329,7 +39329,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39340,7 +39340,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", @@ -39376,7 +39376,7 @@ { "key": "response-recursively-retrieving-a-tree", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -39387,7 +39387,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response recursively retrieving a tree", + "description": "

    Response recursively retrieving a tree

    ", "example": { "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", @@ -39440,13 +39440,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ "Actionscript", "Android", @@ -39496,7 +39496,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "name": "NAME" @@ -39505,7 +39505,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" @@ -39680,13 +39680,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -40096,7 +40096,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -40105,7 +40105,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -40534,7 +40534,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -40544,7 +40544,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -40872,7 +40872,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -40893,7 +40893,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -41125,7 +41125,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41136,7 +41136,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -41496,7 +41496,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", @@ -41519,7 +41519,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -41772,7 +41772,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41782,7 +41782,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41853,7 +41853,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -41863,7 +41863,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -41998,13 +41998,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -42341,7 +42341,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42351,7 +42351,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -42432,7 +42432,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -42442,7 +42442,7 @@ }, "response": { "statusCode": "204", - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned." + "description": "

    If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

    " } } ], @@ -42515,7 +42515,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -42532,7 +42532,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -42758,7 +42758,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ @@ -42775,7 +42775,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDU6SXNzdWUx", @@ -43035,7 +43035,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43045,7 +43045,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -43141,7 +43141,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43152,7 +43152,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -43253,7 +43253,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -43267,7 +43267,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -43357,7 +43357,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43367,7 +43367,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -43450,7 +43450,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43461,7 +43461,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -43568,7 +43568,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" @@ -43582,7 +43582,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", @@ -43695,7 +43695,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43705,7 +43705,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -43932,7 +43932,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -43943,7 +43943,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", @@ -44234,7 +44234,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44245,7 +44245,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -44360,7 +44360,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44371,7 +44371,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -44465,7 +44465,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -44482,7 +44482,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -44580,7 +44580,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "labels": [ @@ -44597,7 +44597,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -44680,7 +44680,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44690,7 +44690,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -44758,7 +44758,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44770,7 +44770,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -44853,7 +44853,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -44863,7 +44863,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -44962,7 +44962,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "bug", @@ -44977,7 +44977,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -45049,7 +45049,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45060,7 +45060,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -45157,7 +45157,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "bug :bug:", @@ -45173,7 +45173,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", @@ -45237,7 +45237,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45247,7 +45247,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -45320,7 +45320,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45331,7 +45331,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 208045946, @@ -45460,7 +45460,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45470,7 +45470,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", @@ -45603,7 +45603,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -45619,7 +45619,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -45719,7 +45719,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45730,7 +45730,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -45870,7 +45870,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "v1.0", @@ -45887,7 +45887,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -45979,7 +45979,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -45989,7 +45989,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46068,7 +46068,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46078,7 +46078,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46144,13 +46144,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "mit", @@ -46242,7 +46242,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "license": "LICENSE" @@ -46251,7 +46251,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "mit", "name": "MIT License", @@ -46334,7 +46334,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46344,7 +46344,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "name": "LICENSE", "path": "LICENSE", @@ -46437,12 +46437,12 @@ "key": "200", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46501,12 +46501,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46533,13 +46533,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { @@ -46621,12 +46621,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46653,12 +46653,12 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -46709,7 +46709,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46719,7 +46719,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "description": "

    Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

    ", "example": [ [ 1302998400, @@ -46780,7 +46780,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46790,7 +46790,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "days": [ @@ -46859,7 +46859,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46869,7 +46869,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "
      \n
    • w - Start of the week, given as a Unix timestamp.
    • \n
    • a - Number of additions
    • \n
    • d - Number of deletions
    • \n
    • c - Number of commits
    • \n
    ", "example": [ { "author": { @@ -46956,7 +46956,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -46966,7 +46966,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The array order is oldest week (index 0) to most recent week.", + "description": "

    The array order is oldest week (index 0) to most recent week.

    ", "example": { "all": [ 11, @@ -47126,7 +47126,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -47136,7 +47136,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "description": "

    For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

    ", "example": [ [ 0, @@ -47234,7 +47234,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -47243,7 +47243,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 79, @@ -47520,7 +47520,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repositories": [ @@ -47535,7 +47535,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -47765,7 +47765,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -47775,7 +47775,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "description": "
      \n
    • pending, which means the migration hasn't started yet.
    • \n
    • exporting, which means the migration is in progress.
    • \n
    • exported, which means the migration finished successfully.
    • \n
    • failed, which means the migration failed.
    • \n
    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -47985,13 +47985,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 79, @@ -48282,13 +48282,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", @@ -48559,7 +48559,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" @@ -48568,7 +48568,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -48727,13 +48727,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -48790,7 +48790,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -48799,7 +48799,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "github", "id": 1, @@ -49094,7 +49094,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "billing_email": "mona@github.com", @@ -49115,7 +49115,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "github", "id": 1, @@ -49231,7 +49231,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -49240,7 +49240,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "installations": [ @@ -49342,13 +49342,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -49431,7 +49431,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -49440,7 +49440,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "github", @@ -49543,7 +49543,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -49552,7 +49552,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -49628,7 +49628,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -49637,7 +49637,7 @@ }, "response": { "statusCode": "204", - "description": "Response if requester is an organization member and user is a member" + "description": "

    Response if requester is an organization member and user is a member

    " } } ], @@ -49691,7 +49691,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -49700,7 +49700,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -49750,7 +49750,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -49760,7 +49760,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -49870,7 +49870,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -49880,7 +49880,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user has an active admin membership with organization", + "description": "

    Response if user has an active admin membership with organization

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -49974,7 +49974,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -49983,7 +49983,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50050,13 +50050,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", @@ -50191,7 +50191,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -50200,7 +50200,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", @@ -50299,7 +50299,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "active" @@ -50311,7 +50311,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", @@ -50434,7 +50434,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -50443,7 +50443,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -50511,7 +50511,7 @@ { "key": "202", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -50520,13 +50520,13 @@ }, "response": { "statusCode": "202", - "description": "User is getting converted asynchronously" + "description": "

    User is getting converted asynchronously

    " } }, { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -50535,7 +50535,7 @@ }, "response": { "statusCode": "204", - "description": "User was converted" + "description": "

    User was converted

    " } } ], @@ -50593,7 +50593,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -50602,7 +50602,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -50663,7 +50663,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -50672,7 +50672,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -50948,7 +50948,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -50969,7 +50969,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -51042,7 +51042,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51052,7 +51052,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -51293,7 +51293,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -51309,7 +51309,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", @@ -51381,7 +51381,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51390,7 +51390,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51440,7 +51440,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51450,7 +51450,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -51560,7 +51560,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51570,7 +51570,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -51640,7 +51640,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51650,7 +51650,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -51741,7 +51741,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51752,7 +51752,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -51857,7 +51857,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51867,7 +51867,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -51921,7 +51921,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -51930,7 +51930,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -51983,7 +51983,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -51993,7 +51993,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -52134,7 +52134,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "source": { @@ -52150,7 +52150,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", @@ -52299,7 +52299,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "cname": "octocatblog.com", @@ -52315,7 +52315,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52369,7 +52369,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52378,7 +52378,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -52452,7 +52452,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52462,7 +52462,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", @@ -52541,7 +52541,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52551,7 +52551,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", "status": "queued" @@ -52601,7 +52601,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52611,7 +52611,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -52697,7 +52697,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -52708,7 +52708,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", @@ -52813,7 +52813,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -52822,7 +52822,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -52919,7 +52919,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Organization Roadmap", @@ -52932,7 +52932,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -53023,7 +53023,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -53032,7 +53032,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -53180,7 +53180,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -53189,7 +53189,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -53284,7 +53284,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -53292,7 +53292,7 @@ }, "response": { "statusCode": "204", - "description": "Delete Success" + "description": "

    Delete Success

    " } } ], @@ -53391,7 +53391,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -53401,7 +53401,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", @@ -53523,7 +53523,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Projects Documentation", @@ -53537,7 +53537,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", @@ -53647,13 +53647,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", @@ -53773,7 +53773,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -53782,7 +53782,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/users/octocat", @@ -53862,7 +53862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -53871,7 +53871,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -53985,7 +53985,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -53994,7 +53994,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -54083,7 +54083,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -54091,7 +54091,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54171,7 +54171,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" @@ -54179,7 +54179,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54269,7 +54269,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -54278,7 +54278,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/cards/1478", @@ -54402,7 +54402,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -54411,7 +54411,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, @@ -54535,7 +54535,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -54544,7 +54544,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -54652,7 +54652,7 @@ "key": "204", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -54661,7 +54661,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54727,7 +54727,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -54736,7 +54736,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -54802,7 +54802,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", @@ -54812,7 +54812,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "permission": "admin", "user": { @@ -54894,7 +54894,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -54903,7 +54903,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -54980,7 +54980,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -54989,7 +54989,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -55048,7 +55048,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -55056,7 +55056,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -55120,7 +55120,7 @@ "key": "201", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" @@ -55128,7 +55128,7 @@ }, "response": { "statusCode": "201", - "description": "Response" + "description": "

    Response

    " } } ], @@ -55199,7 +55199,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -55208,7 +55208,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/projects/columns/367", @@ -55283,7 +55283,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" @@ -55292,7 +55292,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", @@ -55447,7 +55447,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -55457,7 +55457,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -56098,7 +56098,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Amazing new feature", @@ -56114,7 +56114,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -56710,7 +56710,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -56721,7 +56721,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Pass the appropriate [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "

    Pass the appropriate media type to fetch diff and patch formats.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -57372,7 +57372,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "new title", @@ -57389,7 +57389,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -58003,7 +58003,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58014,7 +58014,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", @@ -58167,7 +58167,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58178,7 +58178,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", @@ -58255,7 +58255,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58265,7 +58265,7 @@ }, "response": { "statusCode": "204", - "description": "Response if pull request has been merged" + "description": "

    Response if pull request has been merged

    " } } ], @@ -58367,7 +58367,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58378,7 +58378,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if merge was successful", + "description": "

    if merge was successful

    ", "example": { "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "merged": true, @@ -58469,7 +58469,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" @@ -58483,7 +58483,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "message": "Updating pull request branch.", "url": "https://github.com/repos/octocat/Hello-World/pulls/53" @@ -58599,7 +58599,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58609,7 +58609,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -58722,7 +58722,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58733,7 +58733,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -58859,7 +58859,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "I like this too!" @@ -58873,7 +58873,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -58984,7 +58984,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -58994,7 +58994,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -59108,7 +59108,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -59119,7 +59119,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -59256,11 +59256,15 @@ }, { "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "description": "

    This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + }, "name": "position", "in": "body", "rawType": "integer", - "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "rawDescription": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", "childParamsGroups": [] }, { @@ -59327,7 +59331,7 @@ "key": "example-for-a-multi-line-comment", "request": { "contentType": "application/json", - "description": "Example for a multi-line comment", + "description": "

    Example for a multi-line comment

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!", @@ -59347,7 +59351,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -59408,7 +59412,7 @@ } ], "previews": [], - "descriptionHTML": "

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    \n

    You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required.

    \n

    Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    \n

    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.

    ", + "descriptionHTML": "

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    \n

    The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

    \n

    Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    \n

    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.

    ", "statusCodes": [ { "httpStatusCode": "201", @@ -59486,7 +59490,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!" @@ -59501,7 +59505,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, @@ -59636,7 +59640,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -59647,7 +59651,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "users": [ { @@ -59768,7 +59772,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -59789,7 +59793,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -60436,7 +60440,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "reviewers": [ @@ -60456,7 +60460,7 @@ }, "response": { "statusCode": "200", - "description": "Response" + "description": "

    Response

    " } } ], @@ -60535,7 +60539,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60546,7 +60550,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "The list of reviews returns in chronological order.", + "description": "

    The list of reviews returns in chronological order.

    ", "example": [ { "id": 80, @@ -60844,7 +60848,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", @@ -60867,7 +60871,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -60978,7 +60982,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -60990,7 +60994,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -61108,7 +61112,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is close to perfect! Please address the suggested inline change. And add more about this." @@ -61123,7 +61127,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -61230,7 +61234,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61242,7 +61246,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -61371,7 +61375,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61383,7 +61387,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", @@ -61525,7 +61529,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61537,7 +61541,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -61673,7 +61677,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -61685,7 +61689,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", @@ -61766,13 +61770,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "resources": { "core": { @@ -61925,7 +61929,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -61937,7 +61941,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -62052,7 +62056,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -62067,7 +62071,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the reaction type has already been added to this team discussion comment", + "description": "

    Response when the reaction type has already been added to this team discussion comment

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -62100,7 +62104,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -62115,7 +62119,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -62220,7 +62224,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -62232,7 +62236,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -62326,7 +62330,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -62337,7 +62341,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -62443,7 +62447,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -62457,7 +62461,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -62490,7 +62494,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -62504,7 +62508,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -62600,7 +62604,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -62611,7 +62615,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -62705,7 +62709,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -62716,7 +62720,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -62826,7 +62830,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -62840,7 +62844,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -62873,7 +62877,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -62887,7 +62891,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -62991,7 +62995,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63002,7 +63006,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63096,7 +63100,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63107,7 +63111,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -63217,7 +63221,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -63231,7 +63235,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -63264,7 +63268,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -63278,7 +63282,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -63378,7 +63382,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63389,7 +63393,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63483,7 +63487,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63494,7 +63498,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -63608,7 +63612,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -63622,7 +63626,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -63655,7 +63659,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -63669,7 +63673,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -63769,7 +63773,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63780,7 +63784,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -63874,7 +63878,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -63885,7 +63889,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -63995,7 +63999,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -64009,7 +64013,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -64042,7 +64046,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -64056,7 +64060,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -64156,7 +64160,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64167,7 +64171,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64259,7 +64263,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64270,7 +64274,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -64382,7 +64386,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -64396,7 +64400,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Reaction exists", + "description": "

    Reaction exists

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -64429,7 +64433,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" @@ -64443,7 +64447,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Reaction created", + "description": "

    Reaction created

    ", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", @@ -64543,7 +64547,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64554,7 +64558,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -64580,6 +64584,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -64624,7 +64629,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64634,7 +64639,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", @@ -64725,8 +64730,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -64734,6 +64738,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -64818,7 +64823,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -64836,7 +64841,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -64926,8 +64931,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -64935,6 +64939,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -64961,7 +64966,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -64971,7 +64976,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -65057,8 +65062,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -65066,6 +65070,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65102,7 +65107,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65113,7 +65118,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -65203,8 +65208,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -65212,6 +65216,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65247,7 +65252,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65258,7 +65263,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#hypermedia).", + "description": "

    Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -65348,8 +65353,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -65357,6 +65361,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65448,7 +65453,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", @@ -65467,7 +65472,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -65553,8 +65558,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -65562,6 +65566,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65597,7 +65602,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65607,7 +65612,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -65618,8 +65623,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ @@ -65665,7 +65669,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65676,7 +65680,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/github-ae@latest/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "

    To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -65804,7 +65808,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "foo-1.0.0-osx.zip", @@ -65819,7 +65823,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -65908,7 +65912,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -65918,7 +65922,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -65991,7 +65995,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66002,7 +66006,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", @@ -66111,7 +66115,7 @@ "key": "default", "request": { "contentType": "*/*", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66122,7 +66126,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for successful upload", + "description": "

    Response for successful upload

    ", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -66265,7 +66269,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -66274,7 +66278,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -66597,7 +66601,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -66615,7 +66619,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -66793,7 +66797,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -66803,7 +66807,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -67832,7 +67836,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Hello-World", @@ -67851,7 +67855,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -68422,7 +68426,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68431,7 +68435,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68498,7 +68502,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68508,7 +68512,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "errors": [ { @@ -68607,7 +68611,7 @@ { "key": "response-if-repository-contains-content", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68617,7 +68621,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if repository contains content", + "description": "

    if repository contains content

    ", "example": [ { "login": "octocat", @@ -68722,7 +68726,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "event_type": "on-demand-test", @@ -68738,7 +68742,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -68788,7 +68792,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68798,7 +68802,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "C": 78769, "Python": 7769 @@ -68866,7 +68870,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68876,7 +68880,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "name": "v0.1", @@ -68952,7 +68956,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -68962,7 +68966,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -69042,7 +69046,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -69052,7 +69056,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -69124,7 +69128,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "names": [ @@ -69142,7 +69146,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "names": [ "octocat", @@ -69227,7 +69231,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_owner": "github", @@ -69244,7 +69248,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -69565,7 +69569,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "owner": "octocat", @@ -69582,7 +69586,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -69835,13 +69839,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": [ { "id": 1296269, @@ -70224,13 +70228,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -70477,7 +70481,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -70486,7 +70490,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -70650,7 +70654,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70660,7 +70664,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -70733,7 +70737,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", @@ -70747,7 +70751,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "response", + "description": "

    response

    ", "example": { "id": 1, "key_prefix": "TICKET-", @@ -70811,7 +70815,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70822,7 +70826,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "key_prefix": "TICKET-", @@ -70886,7 +70890,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70896,7 +70900,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -70967,7 +70971,7 @@ { "key": "response-if-content-is-a-file", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -70978,7 +70982,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a file", + "description": "

    Response if content is a file

    ", "example": { "type": "file", "encoding": "base64", @@ -71002,7 +71006,7 @@ { "key": "response-if-content-is-a-directory", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71013,7 +71017,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a directory", + "description": "

    Response if content is a directory

    ", "example": [ { "type": "file", @@ -71053,7 +71057,7 @@ { "key": "response-if-content-is-a-symlink", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71064,7 +71068,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a symlink", + "description": "

    Response if content is a symlink

    ", "example": { "type": "symlink", "target": "/path/to/symlink/target", @@ -71087,7 +71091,7 @@ { "key": "response-if-content-is-a-submodule", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71098,7 +71102,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if content is a submodule", + "description": "

    Response if content is a submodule

    ", "example": { "type": "submodule", "submodule_git_url": "git://github.com/jquery/qunit.git", @@ -71383,7 +71387,7 @@ "key": "example-for-creating-a-file", "request": { "contentType": "application/json", - "description": "Example for creating a file", + "description": "

    Example for creating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -71402,7 +71406,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -71461,7 +71465,7 @@ "key": "example-for-updating-a-file", "request": { "contentType": "application/json", - "description": "Example for updating a file", + "description": "

    Example for updating a file

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "a new commit message", @@ -71481,7 +71485,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": { "name": "hello.txt", @@ -71744,7 +71748,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", @@ -71763,7 +71767,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content": null, "commit": { @@ -71871,7 +71875,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71881,7 +71885,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -71972,7 +71976,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -71983,7 +71987,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "file", "encoding": "base64", @@ -72064,7 +72068,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72074,7 +72078,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72129,7 +72133,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72139,7 +72143,7 @@ }, "response": { "statusCode": "302", - "description": "Response" + "description": "

    Response

    " } } ], @@ -72221,7 +72225,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72231,7 +72235,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -72408,7 +72412,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -72418,7 +72422,7 @@ "response": { "statusCode": "202", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -72991,7 +72995,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73000,7 +73004,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -73050,7 +73054,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -73059,7 +73063,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -73143,13 +73147,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 7, "incomplete_results": false, @@ -73329,13 +73333,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 1, "incomplete_results": false, @@ -73558,13 +73562,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 280, "incomplete_results": false, @@ -73771,13 +73775,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 2, "incomplete_results": false, @@ -73903,13 +73907,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 40, "incomplete_results": false, @@ -74086,13 +74090,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 6, "incomplete_results": false, @@ -74263,13 +74267,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "total_count": 12, "incomplete_results": false, @@ -74407,7 +74411,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74417,7 +74421,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "number": 2, @@ -74527,7 +74531,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -74538,7 +74542,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -74651,7 +74655,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "resolved", @@ -74666,7 +74670,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", @@ -74769,7 +74773,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -74778,7 +74782,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -74915,7 +74919,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Justice League", @@ -74930,7 +74934,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -75032,7 +75036,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -75042,7 +75046,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -75200,7 +75204,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -75215,7 +75219,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -75309,7 +75313,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -75318,7 +75322,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75382,7 +75386,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -75392,7 +75396,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -75490,7 +75494,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -75501,7 +75505,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -75617,7 +75621,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -75627,7 +75631,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75686,7 +75690,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -75696,7 +75700,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -75760,7 +75764,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -75770,7 +75774,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -75940,7 +75944,7 @@ { "key": "alternative-response-with-repository-permissions", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -75952,7 +75956,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with repository permissions", + "description": "

    Alternative response with repository permissions

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -76292,7 +76296,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -76303,7 +76307,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -76367,7 +76371,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -76378,7 +76382,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -76442,7 +76446,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -76452,7 +76456,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -76517,7 +76521,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -76526,7 +76530,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -76675,7 +76679,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -76689,7 +76693,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response when the updated information already exists", + "description": "

    Response when the updated information already exists

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -76744,7 +76748,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", @@ -76758,7 +76762,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 1, "node_id": "MDQ6VGVhbTE=", @@ -76859,7 +76863,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -76867,7 +76871,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -76930,7 +76934,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -76939,7 +76943,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", @@ -77032,7 +77036,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -77042,7 +77046,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", @@ -77149,7 +77153,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -77158,7 +77162,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77216,7 +77220,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -77225,7 +77229,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77288,7 +77292,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -77297,7 +77301,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1296269, @@ -77462,7 +77466,7 @@ { "key": "alternative-response-with-extra-repository-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -77473,7 +77477,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Alternative response with extra repository information", + "description": "

    Alternative response with extra repository information

    ", "example": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", @@ -77801,7 +77805,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -77811,7 +77815,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77874,7 +77878,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -77884,7 +77888,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -77939,7 +77943,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -77948,7 +77952,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "if child teams exist", + "description": "

    if child teams exist

    ", "example": [ { "id": 2, @@ -78034,13 +78038,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -78192,7 +78196,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -78203,7 +78207,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -78316,7 +78320,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -78330,7 +78334,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -78439,7 +78443,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -78451,7 +78455,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -78571,7 +78575,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -78586,7 +78590,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -78695,7 +78699,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -78706,7 +78710,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -78784,7 +78788,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -78794,7 +78798,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -78898,7 +78902,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" @@ -78911,7 +78915,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -79011,7 +79015,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -79022,7 +79026,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -79133,7 +79137,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" @@ -79147,7 +79151,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -79247,7 +79251,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -79257,7 +79261,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -79346,7 +79350,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -79356,7 +79360,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -79484,7 +79488,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -79498,7 +79502,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -79603,7 +79607,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -79614,7 +79618,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -79739,7 +79743,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -79753,7 +79757,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -79858,7 +79862,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -79868,7 +79872,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -79937,7 +79941,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -79946,7 +79950,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "author": { @@ -80065,7 +80069,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Our first team post", @@ -80078,7 +80082,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -80174,7 +80178,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -80184,7 +80188,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -80300,7 +80304,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" @@ -80313,7 +80317,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "author": { "login": "octocat", @@ -80409,7 +80413,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -80418,7 +80422,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80466,7 +80470,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80476,7 +80480,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "group_id": "123", "group_name": "Octocat admins", @@ -80567,7 +80571,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" @@ -80576,7 +80580,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "groups": [ { @@ -80650,7 +80654,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "group_id": 123 @@ -80663,7 +80667,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "group_id": "123", "group_name": "Octocat admins", @@ -80738,7 +80742,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80747,7 +80751,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -80828,7 +80832,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80838,7 +80842,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -80915,7 +80919,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -80926,7 +80930,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -81006,7 +81010,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81017,7 +81021,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -81085,7 +81089,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", @@ -81095,7 +81099,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81169,7 +81173,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" @@ -81178,7 +81182,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -81250,7 +81254,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81259,7 +81263,7 @@ }, "response": { "statusCode": "204", - "description": "if user is a member" + "description": "

    if user is a member

    " } } ], @@ -81309,7 +81313,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81318,7 +81322,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81376,7 +81380,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81385,7 +81389,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81435,7 +81439,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81445,7 +81449,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user is a team maintainer", + "description": "

    Response if user is a team maintainer

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", @@ -81516,7 +81520,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81526,7 +81530,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response if user's membership with team is now pending", + "description": "

    Response if user's membership with team is now pending

    ", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", @@ -81589,7 +81593,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", @@ -81598,7 +81602,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -81632,13 +81636,13 @@ { "key": "response-with-public-and-private-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public and private profile information", + "description": "

    Response with public and private profile information

    ", "example": { "login": "octocat", "id": 1, @@ -81690,13 +81694,13 @@ { "key": "response-with-public-profile-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with public profile information", + "description": "

    Response with public profile information

    ", "example": { "login": "octocat", "id": 1, @@ -81864,13 +81868,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "login": "octocat", "id": 1, @@ -81982,13 +81986,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -82051,7 +82055,7 @@ { "key": "default-response", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -82060,7 +82064,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Default response", + "description": "

    Default response

    ", "example": { "login": "octocat", "id": 1, @@ -82100,7 +82104,7 @@ { "key": "response-with-git-hub-plan-information", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -82109,7 +82113,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response with GitHub plan information", + "description": "

    Response with GitHub plan information

    ", "example": { "login": "octocat", "id": 1, @@ -82214,7 +82218,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -82223,7 +82227,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "contexts": [ { @@ -82288,13 +82292,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -82374,13 +82378,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -82451,7 +82455,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -82459,7 +82463,7 @@ }, "response": { "statusCode": "204", - "description": "if the person is followed by the authenticated user" + "description": "

    if the person is followed by the authenticated user

    " } } ], @@ -82512,7 +82516,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -82520,7 +82524,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82573,7 +82577,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -82581,7 +82585,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -82652,7 +82656,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -82661,7 +82665,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -82738,7 +82742,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -82747,7 +82751,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "login": "octocat", @@ -82815,7 +82819,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", @@ -82824,7 +82828,7 @@ }, "response": { "statusCode": "204", - "description": "if the user follows the target user" + "description": "

    if the user follows the target user

    " } } ], @@ -82876,13 +82880,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -82973,13 +82977,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -83071,7 +83075,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -83080,7 +83084,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 3, "primary_key_id": 2, @@ -83168,7 +83172,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" @@ -83176,7 +83180,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83251,7 +83255,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -83260,7 +83264,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 3, @@ -83345,13 +83349,13 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", @@ -83438,13 +83442,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -83510,7 +83514,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -83519,7 +83523,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, @@ -83581,7 +83585,7 @@ { "key": "204", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" @@ -83589,7 +83593,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -83660,7 +83664,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" @@ -83669,7 +83673,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 1, @@ -83734,7 +83738,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -83745,7 +83749,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -83864,7 +83868,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -83875,7 +83879,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "content_type": "json", "insecure_ssl": "0", @@ -83956,7 +83960,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -83967,7 +83971,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "id": 12345678, @@ -84067,7 +84071,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84079,7 +84083,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -84193,7 +84197,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84204,7 +84208,7 @@ }, "response": { "statusCode": "202", - "description": "Accepted" + "description": "

    Accepted

    " } } ], @@ -84278,7 +84282,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84288,7 +84292,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": [ { "type": "Repository", @@ -84577,7 +84581,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "web", @@ -84600,7 +84604,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -84693,7 +84697,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -84704,7 +84708,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -85018,7 +85022,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "active": true, @@ -85035,7 +85039,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response", + "description": "

    Response

    ", "example": { "type": "Repository", "id": 12345678, @@ -85124,7 +85128,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85134,7 +85138,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85193,7 +85197,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85203,7 +85207,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], @@ -85262,7 +85266,7 @@ { "key": "default", "request": { - "description": "Example", + "description": "

    Example

    ", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", @@ -85272,7 +85276,7 @@ }, "response": { "statusCode": "204", - "description": "Response" + "description": "

    Response

    " } } ], diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 653d901bd4..68cd4b7fff 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -366371,14 +366371,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -389968,14 +389968,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -390590,14 +390590,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -391251,14 +391251,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -406869,14 +406869,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -407397,7 +407397,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -407453,7 +407453,11 @@ }, "position": { "type": "integer", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + } }, "side": { "type": "string", @@ -407565,14 +407569,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -408320,14 +408324,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 1160c15dca..f2d20bf06f 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -306189,14 +306189,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -329539,14 +329539,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -330171,14 +330171,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -330842,14 +330842,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -340506,14 +340506,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -341100,7 +341100,11 @@ }, "position": { "type": "integer", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + } }, "side": { "type": "string", @@ -341212,14 +341216,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -341973,14 +341977,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index cba9879d70..1cc6738894 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -314207,14 +314207,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -337592,14 +337592,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -338224,14 +338224,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -338895,14 +338895,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -348559,14 +348559,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -349153,7 +349153,11 @@ }, "position": { "type": "integer", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + } }, "side": { "type": "string", @@ -349265,14 +349269,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -350026,14 +350030,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 1824703a44..59164a6fe3 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -317558,14 +317558,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -341090,14 +341090,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -341712,14 +341712,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -342373,14 +342373,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -352016,14 +352016,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -352544,7 +352544,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -352600,7 +352600,11 @@ }, "position": { "type": "integer", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + } }, "side": { "type": "string", @@ -352712,14 +352716,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -353467,14 +353471,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 8dc95facfc..7c3b0126c7 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -333487,14 +333487,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -357019,14 +357019,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -357641,14 +357641,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -358302,14 +358302,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -367945,14 +367945,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -368473,7 +368473,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.4/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.4/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -368529,7 +368529,11 @@ }, "position": { "type": "integer", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + } }, "side": { "type": "string", @@ -368641,14 +368645,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -369396,14 +369400,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 2d90019686..b5f9dd6eea 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -297949,14 +297949,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -321102,14 +321102,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -321724,14 +321724,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -322385,14 +322385,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -332043,14 +332043,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -332571,7 +332571,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -332627,7 +332627,11 @@ }, "position": { "type": "integer", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + "description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + } }, "side": { "type": "string", @@ -332739,14 +332743,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 @@ -333494,14 +333498,14 @@ ] }, "position": { - "description": "The line index in the diff to which the comment applies.", + "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", "type": "integer", "examples": [ 1 ] }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies.", + "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", "type": "integer", "examples": [ 4 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 bde320f16c..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:7930d8f7b32cef34fc71240548ec512d7562622221aa0a0ec12385ee86c43d71 -size 665239 +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 388ce441e2..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:c9196841a2c5319ed496e72fab51893484e90b5bb4138b0ca86232ce3ea6f65e -size 1325938 +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 e408169404..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:403f9807bee726f5018f01b85dd03cc24ddff85d93188084a17389bca37b7e34 -size 895246 +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 0457060465..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:59b2ee9de9688732065a3f0c52e2de5f78b847473ddaa259644e001311569ce0 -size 3444014 +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 e2d7e3294b..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:8929b8241c3b05f3ac7cf3f9c6713ebcedc67bf05866267981434a90417c4c2b -size 612054 +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 637fd8aae7..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:1941cc038f7cb40cb22050dde1edbb73f4d004bf67749581ab81d0d2626b5082 -size 2585615 +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 98f9325b09..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:9128c831b7bf1e7ee7482494547614a2d43fc892223449d1679383af1a1e0bce -size 675826 +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 719c5b6f14..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:737e58c1600c6ecc23139b8020f34ecba830456da77eb0ff67bdf02eb6089b0a -size 3605569 +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 3abef43f7f..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:fc2d44b0a53ee941c1271b3bb45c1566cba6b64922cd6ef893e323677a8920fb -size 604250 +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 cf4705e7eb..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:81936882fe37134af4b6e2c3a14156090a7ad4b60729bf37fcd86c5a5c5ca9fd -size 2478485 +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 ae48eff446..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:b7cef4a6c1080a7a1243e501cd4f1c70df3b04ba4dd429b5f284fd4b9530097e -size 683077 +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 a50204d4c3..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:9c9b13f7ade44d18f26e8c0c92097c256142033107b85de7f823b0ab989d1428 -size 1355893 +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 78b09741b2..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:c912ac68cbb2724d4ba444fdf6349e68a70dad12adbe9fa1c998eb3ef88d1d9f -size 924490 +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 03603c459c..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:d5ff65dbdd77b76f762cb46783dac723b80c01a2500b5ab32eb707114666b830 -size 3559967 +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 52215646c2..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:80996fbe6ebf5ff0c0dfee7ec2d3f8b208fb198dada3a8056f89772cc050a75c -size 628486 +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 41e92a7e24..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:fe7fb9293fef6540ce90e865726fe002a28fa867bdc3d8db8946f4c662dd41e1 -size 2657131 +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 146800ff77..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:0be3b5cc5453175d92642a2faad19c06797aa8d057a6d82b181565f724c5d8ee -size 693076 +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 1d1d79bacf..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:8c5b8d53c2d4b51d9db9c3d7c8fd136d7ec196507589fc698b5548b51bffc51a -size 3701038 +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 9fb0a3b541..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:f272ca6be5ff15349e59e5a225173f2105f8d3d0fe3ee59e2f97c44adad72de5 -size 619683 +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 ff6b8eb083..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:66daf06d68131e1124db81de5f176ff005a87e342874572a61300a00ccf87d35 -size 2538411 +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 aa3410a7bb..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:1efe89ff7ab18b4cc0b04bcbf71990c9996f9a82ed4aa2866f11af0341b5098f -size 706103 +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 e1697eda85..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:427587dd86fbd70935bbb7a43373a54ac131c6e410f655cbe57e98fd958c2544 -size 1404201 +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 c148530a7c..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:779691a2ca7fb89c41740f8be6fd281ff62ebbce3a50d19991c6cb431718b21f -size 959835 +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 03fbff0d21..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:d99e824cbaf38f9d8a09ed852f3fe92ae72863df1a6c988bf8b1ded19ee45a5a -size 3681017 +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 6d537fd502..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:d907a7f59a33f29f7ec3add8b1c18b7664296c20d12e244109435789ea947050 -size 647598 +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 507c50bd3c..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:d31ab782d36184f47176b94d86a840ac177313b1eccc225d9eb46c77034b4bd0 -size 2743699 +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 d10040dd03..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:899fa2110363a6caae33b2b27b6e95da91229a4dac3b81e77cb6d527c44769af -size 716757 +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 30e2a175b5..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:5fe658a37b43f9b59d37bf1a97ce024106dd05f2df698a591b06f3ceacc0186b -size 3830471 +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 abed601dcb..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:a4ef6cada055d916a0b8f9c7df2e06bae028f7f320f23cd0e4653fa2244adf09 -size 639817 +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 916c5ba897..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:dcc26396e12780b2aee3c46821c1bf68b5e27ac67af7c7bb5cecdd0af717abb9 -size 2621823 +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 1f77fd4a45..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:c65db37600bfedc493a3daa1680b0c60c35f61cc7327d6d35290cdbfe8a71b8b -size 709172 +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 4b78298cd0..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:7ad4adf5186440f682042a39d62ca8833466521f670bf3d61e33182a3ff13520 -size 1411437 +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 9bf7a1d008..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:1b576e16ab088f9f1ebfca920e769767341b4ca6a06fc012c73b8c90f1b975b0 -size 969735 +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 01d73b9219..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:6842e0bf6893364746313903b52f5ad5cf181dac1995ae4cccdc8a32d39ac8c2 -size 3715738 +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 2b9333c885..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:285746e41e916793e9d8ef6ee2c7c5aca6f1fafd46552e320f0a59a8021d665b -size 653025 +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 c3c84c9bd4..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:e8d06909456fb1f520e03143ca1a123646a8e1a0f3914016f87018586529624a -size 2762648 +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 e12dbf2207..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:fcdab1be665d7452c1e001720925cf1c0b3f7dff448c7b10116e1baa8ba398df -size 721433 +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 24671f54d8..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:cd023009cebe124d8aad54a80323d2d2ba577d9c58d0320991f32d2712f3dbdd -size 3852123 +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 ac292b1508..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:87ba50fdb1fa5bdcd57451c3edd598fe67cbec7610e75c38bd8a1e1ea55bfb48 -size 644026 +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 d35140d574..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:89b0fd77e22f0381379c4c0b468f4b821d6886b658f7b60d23fff71d52428e10 -size 2638134 +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 cfb794d795..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:b77464e399beb34a331e1855ca1b1700f1e1cf492f8e1d60656dcfcdcd09e686 -size 911290 +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 82d78163c2..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:ded955ca3f35bd9574fcd2a39fe3372f073939717066b0deea4042a8eec63e65 -size 1485423 +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 ce06ee3f9f..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:2cb4e2825c4fc20287f1ccfad05e725b0ee798760856735e93f497593b022976 -size 1232214 +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 59bf11d86f..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:8ffef02cb0664c50abcc0a4666fac9e8fe923a9933a1ad1666b0c616526b2921 -size 4442974 +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 259a1a0304..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:58255c63e224aa761b1464d8f8f858073516a0510bc52386116667aaf5cf8d41 -size 821035 +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 51c461649f..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:0cf5ba7b23024c714042eb4112d65e50486d056ee3b142ac1f5f2fef2582670f -size 3316922 +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 284aa8839e..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:05678b9779c0be7275d7312231f6dfd9cfba011f0a10f21a63a56826394d9607 -size 921002 +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 087d8bee7c..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:a45c32a2c8134ac5788765c6ade731a6d8190585b5952851fcb158f7999b591d -size 4687842 +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 7ba55b277e..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:c504bc989ab556d09d25ac169d0a4d33b8486b4dc3dc3ad0796644b4ca20736c -size 808431 +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 4f44d60ff6..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:e4717ce2f3670f50524ba211151087ae5bb34fa11345e5840db236af50e6ceef -size 3164897 +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 268532188b..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:b560f62e731bab232a70eb6dea1e80dcc123b41cd3b8e0b1d147440a8f957949 -size 540381 +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 c65a167056..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:ae27a74e2a40fc53abb1165b1cdb115fcd6ff061aafa1da380836fb3b8aef901 -size 1004682 +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 06a361445d..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:61c714818a1dcdb6fc1f002a0697988d569275b559df2251f76db930f89b5827 -size 750036 +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 006b35ba95..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:5e661edb65f622ee50712f627da2964810bca1cb50d4efe773aa6a9c8f631f06 -size 2835430 +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 124f3c227a..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:0973047ccd53016ab2fb631d7744cef1aef5f81696c00abdbaf503549153f8c7 -size 499443 +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 bbef013885..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:2c56af7686104fe7be4f47520b47d5b8c47a645b68f81e99c5ed3310ded8470b -size 2024626 +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 adcf0226de..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:ef11bb3befa6ce4beff18b356d8017ac70c598fc97669d12f0b766c3210c1931 -size 550722 +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 6fde410c75..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:ab10c4dbe7a146fc9fae601d721fa9d8c3264805ecdee11562a7237c67547681 -size 2804808 +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 dc29e659b0..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:fc35d1dd1e423376a3b88be43707fa68aa59c89fd7fbd966125af0cf274df9fe -size 491571 +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 d3c8ea42ed..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:7d2d3a382019955cd757464e25a09d28c9ab56ea93e1515226189c943f862d6f -size 1919519 +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 009a6cf27b..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:ff02ec385b527d4531e7c34787ecbb2fa192f76acfe7bf31065d0268fe3e7422 -size 856580 +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 b8277216d9..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:b704ad1a6fe294869ee5bfffbc4a62d02c1ac96edab3bda1ff35da414e931ddb -size 1588193 +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 f565e9d44d..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:5b7b1a8b162468aea56557a620683e15b2c82b421a0bfe8f27ee856197ba5d5b -size 1136369 +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 ae6c17aea3..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:aad0bb9514d5cb19630a3df2c414963ca72c3a67c9c83ef14272b83b5fc2fb95 -size 4337916 +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 90e2fe4c0e..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:4b3bffdce2a60ca59adc3bd910155fa54f71be7be15b45302216c71a3cf6752e -size 792219 +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 4beedcdefd..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:fc16a8dc2ae10c41ceee628f0fef682235839ec7cbc02d1a10cf73d9371645ac -size 3357603 +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 981912ea2c..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:81053f47f8268b259fe8410e596ba2f718431b5ff23326cc693f5a902a74fe5e -size 867593 +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 92535fa987..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:130d2443fe10cd87d06af8922e94a4add429eee4b0222f3d57e0e0e2de1b15fb -size 4652828 +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 f65f02bbd6..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:79a1a9d300eebe233b5c3ac2721419c788e09da76e3962f46f05db75b5162829 -size 780231 +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 091e43fc67..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:2d2a9334bc1fb6165e86f11bb249703704715ba0a55144936eaa0a8c9f89eb25 -size 3203694 +oid sha256:21004258f254d9747c86ef4cdc06c4ffc32edb63045d8b7983cbace9c2484606 +size 3194181 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/bookmarklets/README.md b/script/bookmarklets/README.md new file mode 100644 index 0000000000..a7f32618db --- /dev/null +++ b/script/bookmarklets/README.md @@ -0,0 +1,49 @@ +# Bookmarklets + +The [bookmarklets](https://en.wikipedia.org/wiki/Bookmarklet) in this directory are browser shortcuts that may help with reviewing GitHub documentation. We may eventually build the functionality they provide into Docs preview environments, but these are handy hacks for now. + +## Installing bookmarklets + +For each bookmarklet described below, create a new bookmark in your browser with a descriptive name, open the JavaScript file and copy its contents, and paste the JavaScript _as the bookmark's URL_. + +Clicking the bookmark will then execute the JavaScript. + +⚠️ For Safari, you'll need to do the following: + +1. Go to **Safari** > **Preferences** > **Advanced** and enable **Show Develop menu in menu bar**. +2. Go to **Develop** and enable **Allow JavaScript from Smart Search field**. + +## "View in development" toggle + +[`script/bookmarklets/view-in-development.js`](./view-in-development.js) + +When you're looking at a page on docs.github.com or a preview server at preview.ghdocs.com, clicking this bookmarklet will load the same path you're viewing but on your local server running at localhost:4000. + +## "View in production" toggle + +[`script/bookmarklets/view-in-production.js`](./view-in-production.js) + +When you're looking at a page on a preview server at preview.ghdocs.com or your local server running at localhost:4000, clicking this bookmarklet will load the same path you're viewing but on the live documentation site at docs.github.com. + +## Open a docs article in VS Code + +[`script/bookmarklets/open-in-vscode.js`](./open-in-vscode.js) + +When you're looking at a page on either docs.github.com, preview.ghdocs.com, or localhost:400, clicking this bookmarklet will open the source Markdown file from your local checkout in VS Code. + +The installation requires a few steps: + +1. Copy the contents of [`script/bookmarklets/open-in-vscode.js`](./open-in-vscode.js). +1. Browse to https://chriszarate.github.io/bookmarkleter/ and paste the code into the box. +1. Find the path of **your local checkout** of the docs repo you want to open files from (for example, `/Users//repos/docs`). +1. Paste the path in place of where it says `REPLACE_ME` in line 1 (make sure to leave the single quotes around it). +1. Change the title to something like `Open in VSC`. +1. Drag the generated link onto your bookmarks bar. + +## Add preview links to PRs + +[`script/bookmarklets/add-pr-links.js`](./add-pr-links.js) + +This bookmarklet modifies the `Files changed` page of a GitHub pull request that has a current staging deployment. For each Markdown file in the diff view, it adds links to the preview deployment of the file for each version: `FPT / GHEC / GHES / AE`. (Some of these may redirect to another version or 404 if that version of the page doesn't exist.) + +Note: readable JavaScript source lives in `script/bookmarklets/pr-link-source.js`. The bookmarklet code was generated via https://chriszarate.github.io/bookmarkleter. diff --git a/script/bookmarklets/add-pr-links.js b/script/bookmarklets/add-pr-links.js new file mode 100644 index 0000000000..f71a8ff7d8 --- /dev/null +++ b/script/bookmarklets/add-pr-links.js @@ -0,0 +1 @@ +javascript:void%20function(){!async%20function(){function%20a(a,b,c){var%20d=document.createElement(%22A%22);return%20d.innerHTML=b,d.href=c,d.target=%22_blank%22,a.appendChild(d),a}const%20b=/https:\/\/github.com\/github\/([^\/]*)\/pull\/\d*\/files/;if(!window.location.href.match(b))return%20void%20window.alert(%22You're%20not%20on%20a%20PR%20'Files%20changed'%20page.%20\uD83D\uDE43%22);let%20c=window.location.href.replace(/files.*/g,%22%22),d=await%20fetch(c).then(function(a){return%20a.text()}).then(function(a){for(var%20b=new%20DOMParser,c=b.parseFromString(a,%22text/html%22),d=c.getElementsByClassName(%22TimelineItem%22),e=0;e%3Cd.length;e++)for(var%20f,g=d[e],h=g.getElementsByTagName(%22a%22),k=0;k%3Ch.length;k++)if(f=h[k],f.innerText.match(/View%20deployment/))var%20l=f.getAttribute(%22href%22);return%20l});if(null==d)return%20void%20window.alert(%22No%20preview%20deployment%20found!%20\uD83D\uDE2D%22);d=d.replace(/\/$/,%22%22);var%20e=d+%22/en%22,f=d+%22/en/enterprise-cloud%40latest%22,g=d+%22/en/enterprise-server%40latest%22,h=d+%22/en/github-ae%40latest%22;const%20j=document.querySelectorAll(%22div.file-info%22);for(var%20k,l=0;l%3Cj.length;l++)if(k=j[l].querySelector(%22a%22).title,0===k.search(%22data/%22))continue;else{var%20m=/\.md$/,n=0%3C=k.search(m);if(n){console.log(%22link:%20%22+k),k=k.replace(m,%22%22),k=k.replace(/^content/,%22%22),k=k.replace(/\/index/,%22%22);var%20o=document.createElement(%22SPAN%22);o.style.fontFamily=%22-apple-system,BlinkMacSystemFont,Segoe%20UI,Helvetica,Arial,sans-serif%22,o.innerHTML=%22%26nbsp;%20View:%20%22,o=a(o,%22FPT%22,e+k),o.innerHTML+=%22%20/%20%22,o=a(o,%22GHEC%22,f+k),o.innerHTML+=%22%20/%20%22,o=a(o,%22GHES%22,g+k),o.innerHTML+=%22%20/%20%22,o=a(o,%22AE%22,h+k),j[l].appendChild(o)}}}()}(); diff --git a/script/bookmarklets/open-in-vscode.js b/script/bookmarklets/open-in-vscode.js new file mode 100644 index 0000000000..f49fca3df8 --- /dev/null +++ b/script/bookmarklets/open-in-vscode.js @@ -0,0 +1,8 @@ +/* The path to your local copy of repo */ +const checkoutPath = 'REPLACE_ME' + +const filepath = window.location.pathname.replace(/\/en\/([^@]+?@[^@]+?\/)?/, '/content/') +const isIndexFile = filepath.split('/').length < 5 +const filename = isIndexFile ? '/index.md' : '.md' +const fullpath = 'vscode://file' + checkoutPath + filepath + filename +window.open(fullpath, '_blank') diff --git a/script/bookmarklets/pr-link-source.js b/script/bookmarklets/pr-link-source.js new file mode 100644 index 0000000000..cd67aed727 --- /dev/null +++ b/script/bookmarklets/pr-link-source.js @@ -0,0 +1,92 @@ +!(async function () { + const regexp = /https:\/\/github.com\/github\/([^\/]*)\/pull\/\d*\/files/; + + if (!window.location.href.match(regexp)) { + window.alert("You're not on a PR 'Files changed' page. 🙃"); + return + } + + let conversation_url = window.location.href.replace(/files.*/g, ""); + + // get the preview deployment URL by loading the 'Conversation' page, and searching for the 'View deployment' link + let deployment_url = await fetch(conversation_url) + .then(function (response) { + return response.text(); + }) + .then(function (html) { + // Convert the HTML string into a document object + var parser = new DOMParser(); + var doc = parser.parseFromString(html, "text/html"); + + var elements = doc.getElementsByClassName("TimelineItem"); + // Find the element that is a link that contains the text "View deployment" + for (var i = 0; i < elements.length; i++) { + var element = elements[i]; + var links = element.getElementsByTagName("a"); + for (var j = 0; j < links.length; j++) { + var link = links[j]; + if (link.innerText.match(/View deployment/)) { + // Get the href of the link + var deployment_url = link.getAttribute("href"); + } + } + } + // This should return the last link that contains the text "View deployment" (there might be multiple ones if there are multiple deployments) + return deployment_url; + }); + if (deployment_url == null) { + window.alert("No preview deployment found! 😭"); + return; + } + // strip any trailing slash from deployment_url + deployment_url = deployment_url.replace(/\/$/, ""); + + var url_fpt = deployment_url + "/en"; + var url_ghec = deployment_url + "/en/enterprise-cloud@latest"; + var url_ghes = deployment_url + "/en/enterprise-server@latest"; + var url_ae = deployment_url + "/en/github-ae@latest"; + var fpt = "FPT"; + var ghes = "GHES"; + var ghec = "GHEC"; + var ae = "AE"; + + const file_info = document.querySelectorAll("div.file-info"); + for (var i = 0; i < file_info.length; i++) { + var link = file_info[i].querySelector("a").title; + if (link.search("data/") === 0) { + continue; + } else { + var regex = /\.md$/; + var markdownfile = link.search(regex) >= 0; + if (markdownfile) { + console.log("link: " + link); + link = link.replace(regex, ""); + link = link.replace(/^content/, ""); + link = link.replace(/\/index/, ""); + var span = document.createElement("SPAN"); + span.style.fontFamily = + "-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif"; + span.innerHTML = "  View: "; + + span = addLink(span, fpt, url_fpt + link); + span.innerHTML += " / "; + span = addLink(span, ghec, url_ghec + link); + span.innerHTML += " / "; + span = addLink(span, ghes, url_ghes + link); + span.innerHTML += " / "; + span = addLink(span, ae, url_ae + link); + + file_info[i].appendChild(span); + } + } + } + + function addLink(span, link_name, link_href) { + var anchor = document.createElement("A"); + anchor.innerHTML = link_name; + anchor.href = link_href; + anchor.target = "_blank"; + span.appendChild(anchor); + return span; + } +})(); diff --git a/script/bookmarklets/view-in-development.js b/script/bookmarklets/view-in-development.js new file mode 100644 index 0000000000..025d74eb04 --- /dev/null +++ b/script/bookmarklets/view-in-development.js @@ -0,0 +1 @@ +javascript:(()=>{window.location.href=window.location.href.replace(/https:\/\/docs\.github\.com/,'http://localhost:4000').replace(/https:\/\/.*\..*\.(com|net|dev|io|org|ms)/,'http://localhost:4000')})() diff --git a/script/bookmarklets/view-in-production.js b/script/bookmarklets/view-in-production.js new file mode 100644 index 0000000000..a22e139b48 --- /dev/null +++ b/script/bookmarklets/view-in-production.js @@ -0,0 +1 @@ +javascript:(()=>{window.location.href=window.location.href.replace(/http:\/\/localhost:4000/,'https://docs.github.com').replace(/https:\/\/.*\..*\.(com|net|dev|io|org|ms)/,'https://docs.github.com')})() 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..2d6d57b149 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 @@ -97,6 +98,7 @@ export default class Operation { this.renderStatusCodes(), this.renderParameterDescriptions(), this.renderBodyParameterDescriptions(), + this.renderExampleRequestResponseDescriptions(), this.renderPreviewNotes(), ]) @@ -108,11 +110,26 @@ export default class Operation { } } + getExternalDocs() { + return this.#operation.externalDocs + } + async renderDescription() { this.descriptionHTML = await renderContent(this.#operation.description) return this } + async renderExampleRequestResponseDescriptions() { + return Promise.all( + this.codeExamples.map(async (codeExample) => { + codeExample.response.description = await renderContent(codeExample.response.description) + codeExample.request.description = await renderContent(codeExample.request.description) + + return codeExample + }) + ) + } + async renderStatusCodes() { const responses = this.#operation.responses const responseKeys = Object.keys(responses) 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 d1cdc255de..6fc05be9b1 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 @@ -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/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md b/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md index 763a43ffae..2240d69685 100644 --- a/translations/ja-JP/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md +++ b/translations/ja-JP/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 ``` このワークフローは以下のステップを実行します。 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 7adf2c01fc..c1e1ea2515 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 @@ -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)." diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md index 6c596084ba..8bc1ed42f1 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/translations/ja-JP/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/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 95326574a6..a877b5c6af 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/translations/ja-JP/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/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index dda8ad1a66..1c16eab175 100644 --- a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -28,12 +28,13 @@ shortTitle: Upgrading GHES ## アップグレードの準備 1. アップグレードの戦略を決定し、アップグレード先のバージョンを選択してください。 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. {% data variables.product.prodname_enterprise_backup_utilities %} で、プライマリインスタンスの新しいバックアップを作成してください。 詳しい情報については、[{% data variables.product.prodname_enterprise_backup_utilities %}README.md ファイル](https://github.com/github/backup-utils#readme)を参照してください。 -4. アップグレードパッケージを使ってアップグレードをする場合は、{% data variables.product.prodname_ghe_server %} のエンドユーザのためにメンテナンス時間枠をスケジューリングしてください。 ホットパッチを利用している場合、メンテナンスモードは必要ありません。 +1. {% data variables.product.prodname_enterprise_backup_utilities %} で、プライマリインスタンスの新しいバックアップを作成してください。 詳しい情報については、[{% data variables.product.prodname_enterprise_backup_utilities %}README.md ファイル](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. アップグレードパッケージを使ってアップグレードをする場合は、{% data variables.product.prodname_ghe_server %} のエンドユーザのためにメンテナンス時間枠をスケジューリングしてください。 ホットパッチを利用しているなら、メンテナンスモードは必要ありません。 {% note %} - **注釈:** メンテナンスウィンドウは、実行しようとしているアップグレードの種類によります。 ホットパッチを利用するアップグレードは、通常メンテナンスウィンドウを必要としません。 リブートが必要になることもあります。そのリブートは後で行うことができます。 MAJOR.FEATURE.PATCH というバージョン付けのスキームに従い、アップグレードパッケージを使ったパッチのリリースで生じるダウンタイムは、通常 5 分未満です。 データの移行を含むフィーチャリリースは、ストレージの性能および移行するデータの量に応じた時間がかかります。 詳しい情報については"[メンテナンスモードの有効化とスケジューリング](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)"を参照してください。 + **注釈:** メンテナンスウィンドウは、実行しようとしているアップグレードの種類によります。 ホットパッチを利用するアップグレードは、通常メンテナンスウィンドウを必要としません。 リブートが必要になることもあります。そのリブートは後で行うことができます。 MAJOR.FEATURE.PATCH というバージョン付けのスキームに従ったパッチリリースをアップグレードパッケージを行うには、通常 5 分未満のダウンタイムだけが必要です。 データの移行を含むフィーチャリリースは、ストレージのパフォーマンス及び移行するデータの量に応じて時間が長くかかります。 詳しい情報については"[メンテナンスモードの有効化とスケジューリング](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)"を参照してください。 {% endnote %} diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/ja-JP/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/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/translations/ja-JP/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/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md index 73c25de231..9b1c6c39b1 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md @@ -160,6 +160,11 @@ C/C++、C#、Go、Javaなどのコンパイル言語については、{% data va 成果物には、{% data variables.product.prodname_codeql %}によってスキャンされたソースのアーカイブされたコピーが_src.zip_という名前で含まれます。 リポジトリ中のソースコードファイルと_src.zip_中のファイルを比較すれば、どういった種類のファイルが欠けているかが分かります。 分析されなかったファイルの種類が分かれば、{% data variables.product.prodname_codeql %}分析のためのワークフローをどのように変更しなければならないかは簡単に理解できるようになります。 +## Alerts found in generated code + +{% data reusables.code-scanning.alerts-found-in-generated-code %} + + ## データベース中の抽出エラー {% data variables.product.prodname_codeql %}チームは、すべてのそー祖ファイルが確実にスキャンできるようにするため、重要な抽出エラーに取り組んでいます。 とはいえ、{% data variables.product.prodname_codeql %}の抽出部は、データベースの生成時にエラーを生成する事があります。 {% data variables.product.prodname_codeql %}は、データベースの生成の間に生成された抽出エラーと警告に関する情報を、ログファイル中に提供します。 抽出の診断情報は、全体的なデータベースの健全性を示します。 ほとんどの抽出部のエラーは、分析に大きな影響を与えません。 少数の抽出部のエラーは健全なもので、通常は良好な分析状況を示します。 @@ -189,9 +194,7 @@ C/C++、C#、Go、Javaなどのコンパイル言語については、{% data va 一般的に、分析時間は分析されるコードの量に比例します。 たとえば、テストコードを除外したり、一度にコードのサブセットのみを分析する複数のワークフローに分析を分割したりするなど、一度に分析されるコードの量を減らすことで、分析時間を短縮できます。 -Java、C、C++、C# などのコンパイルされた言語の場合、{% data variables.product.prodname_codeql %} はワークフローの実行中に作成されたすべてのコードを分析します。 分析するコードの量を制限するには、`run` ブロックで独自のビルドステップを指定して、分析するコードのみをビルドします。 独自のビルドステップの指定と、`pull_request` および `push` イベントの `paths` または `paths-ignore` フィルタの使用を組み合わせて、特定のコードが変更されたときにのみワークフローが実行されるようにすることができます。 詳細については、「[{% data variables.product.prodname_actions %}のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)」を参照してください。 - -ソースコードをコンパイルすることなく {% data variables.product.prodname_codeql %} が分析する Go、JavaScript、Python、TypeScript などの言語の場合、追加の設定オプションを指定して分析するコードの量を制限できます。 詳しい情報については、「[スキャンするディレクトリを指定する](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)」を参照してください。 +{% data reusables.code-scanning.alerts-found-in-generated-code %} 上記のように分析を複数のワークフローに分割する場合でも、リポジトリ内のすべてのコードを分析する `schedule` で実行されるワークフローを少なくとも 1 つ用意することをお勧めします。 {% data variables.product.prodname_codeql %} はコンポーネント間のデータフローを分析するため、一部の複雑なセキュリティ動作は完全なビルドでのみ検出される場合があります。 diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md b/translations/ja-JP/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/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md +++ b/translations/ja-JP/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/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 275deeeb95..98741cedb4 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 @@ -1,7 +1,7 @@ --- -title: GitHub Advisory Database のセキュリティ脆弱性を参照する -intro: '{% data variables.product.prodname_advisory_database %} を使用すると、{% data variables.product.company_short %} のオープンソースプロジェクトに影響を与える脆弱性を参照または検索できます。' -shortTitle: Advisory Databaseの参照 +title: Browsing security vulnerabilities in the GitHub Advisory Database +intro: 'The {% data variables.product.prodname_advisory_database %} allows you to browse or search for vulnerabilities that affect open source projects on {% data variables.product.company_short %}.' +shortTitle: Browse Advisory Database miniTocMaxHeadingLevel: 3 redirect_from: - /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database @@ -18,104 +18,106 @@ topics: - Vulnerabilities - CVEs --- - -## セキュリティの脆弱性について +## About security vulnerabilities {% data reusables.repositories.a-vulnerability-is %} -## {% data variables.product.prodname_advisory_database %} について +## About the {% data variables.product.prodname_advisory_database %} -{% data variables.product.prodname_advisory_database %}には既知のセキュリティ脆弱性のリストが含まれており、これは{% data variables.product.company_short %}がレビューしたアドバイザリと、レビューされていないアドバイザリという2つの分類にグループ化されています。 +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 reusables.repositories.tracks-vulnerabilities %} -### {% data variables.product.company_short %}がレビューしたアドバイザリについて +### About {% data variables.product.company_short %}-reviewed advisories -{% data variables.product.company_short %}あレビューしたアドバイザリは、{% 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 %}がレビューした各アドバイザリには完全な説明があり、エコシステムとパッケージ情報が含まれます。 +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.prodname_dependabot_alerts %}を有効化すると、新しい{% data variables.product.company_short %}がレビューしたアドバイザリが依存対象のパッケージに影響する場合、自動的に通知されます。 詳しい情報については「[{% data variables.product.prodname_dependabot_alerts %}について](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」を参照してください。 +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. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." -### レビューされていないアドバイザリについて +### About unreviewed advisories -レビューされていないアドバイザリは、自動的にNational Vulnerability Databaseフィードから直接{% data variables.product.prodname_advisory_database %}へ展開されたセキュリティ脆弱性です。 +Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. -この種のアドバイザリは妥当性あるいは完全性がチェックされていないので、レビューされていないアドバイザリに対して{% data variables.product.prodname_dependabot %}は{% data variables.product.prodname_dependabot_alerts %}を生成しません。 +{% 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. ## About security advisories -Each security advisory contains information about the vulnerability, which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. さらに、National Vulnerability Database リストのアドバイザリには、CVE レコードへのリンクが含まれており、脆弱性、その CVSS スコア、その定性的な重要度レベルの詳細を確認できます。 詳しい情報については、アメリカ国立標準技術研究所の「[National Vulnerability Database](https://nvd.nist.gov/)"」を参照してください。 +Each security advisory contains information about the vulnerability, which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology. -重大度レベルは「[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)」で定義されている 4 つのレベルのいずれかです。 +The severity level is one of four possible levels defined in the "[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)." - Low - Medium/Moderate - High - Critical -{% data variables.product.prodname_advisory_database %} は、上記の CVSS レベルを使用します。 {% data variables.product.company_short %} が CVE を取得した場合、{% data variables.product.prodname_advisory_database %} は CVSS バージョン 3.1 を使用します。 CVE がインポートされた場合、{% data variables.product.prodname_advisory_database %} は CVSS バージョン 3.0 と 3.1 の両方をサポートします。 +The {% data variables.product.prodname_advisory_database %} uses the CVSS levels described above. If {% data variables.product.company_short %} obtains a CVE, the {% data variables.product.prodname_advisory_database %} uses CVSS version 3.1. If the CVE is imported, the {% data variables.product.prodname_advisory_database %} supports both CVSS versions 3.0 and 3.1. {% data reusables.repositories.github-security-lab %} -## {% data variables.product.prodname_advisory_database %} のアドバイザリにアクセスする +## Accessing an advisory in the {% data variables.product.prodname_advisory_database %} -1. Https://github.com/advisories にアクセスします。 -2. 必要に応じて、リストをフィルタするには、ドロップダウンメニューを使用します。 ![ドロップダウンフィルタ](/assets/images/help/security/advisory-database-dropdown-filters.png) +1. Navigate to https://github.com/advisories. +2. Optionally, to filter the list, use any of the drop-down menus. + ![Dropdown filters](/assets/images/help/security/advisory-database-dropdown-filters.png) {% tip %} **Tip:** You can use the sidebar on the left to explore {% data variables.product.company_short %}-reviewed and unreviewed advisories separately. {% endtip %} -3. アドバイザリをクリックして詳細を表示します。 +3. Click on any advisory to view details. {% note %} -データベースは、GraphQL API を使用してアクセスすることもできます。 詳しい情報については、「[`security_advisory` webhook イベント](/webhooks/event-payloads/#security_advisory)」を参照してください。 +The database is also accessible using the GraphQL API. For more information, see the "[`security_advisory` webhook event](/webhooks/event-payloads/#security_advisory)." {% endnote %} ## Editing an advisory in the {% data variables.product.prodname_advisory_database %} You can suggest improvements to any advisory in the {% data variables.product.prodname_advisory_database %}. For more information, see "[Editing security advisories in the {% data variables.product.prodname_advisory_database %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database)." -## {% data variables.product.prodname_advisory_database %} を検索する +## Searching the {% data variables.product.prodname_advisory_database %} -データベースを検索し、修飾子を使用して検索を絞り込むことができます。 たとえば、特定の日付、特定のエコシステム、または特定のライブラリで作成されたアドバイザリを検索できます。 +You can search the database, and use qualifiers to narrow your search. For example, you can search for advisories created on a certain date, in a specific ecosystem, or in a particular library. {% data reusables.time_date.date_format %} {% data reusables.time_date.time_format %} {% data reusables.search.date_gt_lt %} -| 修飾子 | サンプル | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type:reviewed` | [**type:reviewed**](https://github.com/advisories?query=type%3Areviewed) will show {% data variables.product.company_short %}-reviewed advisories. | -| `type:unreviewed` | [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. | -| `GHSA-ID` | [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) は、この {% data variables.product.prodname_advisory_database %} ID でアドバイザリを表示します。 | -| `CVE-ID` | [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) は、この CVEID 番号でアドバイザリを表示します。 | -| `ecosystem:ECOSYSTEM` | [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) は、NPM パッケージに影響するアドバイザリのみを表示します。 | -| `severity:LEVEL` | [**severity:high**](https://github.com/advisories?utf8=%E2%9C%93&query=severity%3Ahigh) は、重大度レベルが高いアドバイザリのみを表示します。 | -| `affects:LIBRARY` | [**affects:lodash**](https://github.com/advisories?utf8=%E2%9C%93&query=affects%3Alodash) は、lodash ライブラリに影響するアドバイザリのみを表示します。 | -| `cwe:ID` | [**cwe:352**](https://github.com/advisories?query=cwe%3A352) は、この CWE 番号のアドバイザリのみを表示します。 | -| `credit:USERNAME` | [**credit:octocat**](https://github.com/advisories?query=credit%3Aoctocat) は、「octocat」ユーザアカウントにクレジットされたアドバイザリのみを表示します。 | -| `sort:created-asc` | [**sort:created-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-asc) は、一番古いアドバイザリを最初にソートします。 | -| `sort:created-desc` | [**sort:created-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-desc) は、一番新しいアドバイザリを最初にソートします。 | -| `sort:updated-asc` | [**sort:updated-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-asc) は、最近で最も更新されていないものを最初にソートします。 | -| `sort:updated-desc` | [**sort:updated-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-desc) は、最も直近で更新されたものを最初にソートします。 | -| `is:withdrawn` | [**is:withdrawn**](https://github.com/advisories?utf8=%E2%9C%93&query=is%3Awithdrawn) は、撤回されたアドバイザリのみを表示します。 | -| `created:YYYY-MM-DD` | [**created:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=created%3A2021-01-13) は、この日に作成されたアドバイザリのみを表示します。 | -| `updated:YYYY-MM-DD` | [**updated:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=updated%3A2021-01-13) は、この日に更新されたアドバイザリのみを表示します。 | +| Qualifier | Example | +| ------------- | ------------- | +| `type:reviewed`| [**type:reviewed**](https://github.com/advisories?query=type%3Areviewed) will show {% data variables.product.company_short %}-reviewed advisories. | +| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. | +| `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. | +| `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. | +| `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting NPM packages. | +| `severity:LEVEL`| [**severity:high**](https://github.com/advisories?utf8=%E2%9C%93&query=severity%3Ahigh) will show only advisories with a high severity level. | +| `affects:LIBRARY`| [**affects:lodash**](https://github.com/advisories?utf8=%E2%9C%93&query=affects%3Alodash) will show only advisories affecting the lodash library. | +| `cwe:ID`| [**cwe:352**](https://github.com/advisories?query=cwe%3A352) will show only advisories with this CWE number. | +| `credit:USERNAME`| [**credit:octocat**](https://github.com/advisories?query=credit%3Aoctocat) will show only advisories credited to the "octocat" user account. | +| `sort:created-asc`| [**sort:created-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-asc) will sort by the oldest advisories first. | +| `sort:created-desc`| [**sort:created-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Acreated-desc) will sort by the newest advisories first. | +| `sort:updated-asc`| [**sort:updated-asc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-asc) will sort by the least recently updated first. | +| `sort:updated-desc`| [**sort:updated-desc**](https://github.com/advisories?utf8=%E2%9C%93&query=sort%3Aupdated-desc) will sort by the most recently updated first. | +| `is:withdrawn`| [**is:withdrawn**](https://github.com/advisories?utf8=%E2%9C%93&query=is%3Awithdrawn) will show only advisories that have been withdrawn. | +| `created:YYYY-MM-DD`| [**created:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=created%3A2021-01-13) will show only advisories created on this date. | +| `updated:YYYY-MM-DD`| [**updated:2021-01-13**](https://github.com/advisories?utf8=%E2%9C%93&query=updated%3A2021-01-13) will show only advisories updated on this date. | -## 脆弱性のあるリポジトリを表示する +## Viewing your vulnerable repositories -For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability. 脆弱性のあるリポジトリを確認するには、そのリポジトリの {% data variables.product.prodname_dependabot_alerts %} にアクセスできる必要があります。 詳しい情報については「[{% data variables.product.prodname_dependabot_alerts %}について](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)」を参照してください。 +For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)." -1. Https://github.com/advisories にアクセスします。 -2. アドバイザリをクリックします。 -3. アドバイザリページの上部にある [**Dependabot alerts**] をクリックします。 ![Dependabotアラート](/assets/images/help/security/advisory-database-dependabot-alerts.png) -4. 必要に応じて、リストをフィルタするには、検索バーまたはドロップダウンメニューを使用します。 [Organization] ドロップダウンメニューを使用すると、オーナー(Organization またはユーザ)ごとに {% data variables.product.prodname_dependabot_alerts %} をフィルタできます。 ![アラートをフィルタするための検索バーとドロップダウンメニュー](/assets/images/help/security/advisory-database-dependabot-alerts-filters.png) -5. 脆弱性の詳細、および脆弱性のあるリポジトリを修正する方法に関するアドバイスについては、リポジトリ名をクリックしてください。 +1. Navigate to https://github.com/advisories. +2. Click an advisory. +3. At the top of the advisory page, click **Dependabot alerts**. + ![Dependabot alerts](/assets/images/help/security/advisory-database-dependabot-alerts.png) +4. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user). + ![Search bar and drop-down menus to filter alerts](/assets/images/help/security/advisory-database-dependabot-alerts-filters.png) +5. For more details about the vulnerability, and for advice on how to fix the vulnerable repository, click the repository name. -## 参考リンク +## Further reading -- MITREの[「脆弱性」の定義](https://www.cve.org/ResourcesSupport/Glossary#vulnerability) +- MITRE's [definition of "vulnerability"](https://www.cve.org/ResourcesSupport/Glossary#vulnerability) diff --git a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md index f01bc97fff..cf122e8767 100644 --- a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md +++ b/translations/ja-JP/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: Dependabotアラートの設定 +intro: '依存関係のいずれかで新しい脆弱性が見つかったときに通知してもらえるよう、{% data variables.product.prodname_dependabot_alerts %}を有効化してください。' +shortTitle: Dependabotアラートの設定 versions: fpt: '*' ghes: '*' @@ -17,72 +17,72 @@ topics: - Repositories --- -## About {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies +## 脆弱性のある依存関係に対する{% data variables.product.prodname_dependabot_alerts %}について {% 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. 詳しい情報については「[{% data variables.product.prodname_dependabot_alerts %}について](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)」を参照してください。 +Dependabotは、新しい脆弱性がGitHub Advisory Databaseに追加された場合、あるいはリポジトリの依存関係グラフが変更されたときに、脆弱性のある依存関係を検出するためにスキャンを行い、Dependabotアラートを送信します。 詳しい情報については「[{% 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 +{% data variables.product.prodname_dependabot_alerts %}は、以下に対して有効化あるいは無効化できます。 +* 個人アカウント +* リポジトリ +* Organization -## Managing {% data variables.product.prodname_dependabot_alerts %} for your personal account +## 個人アカウントの{% data variables.product.prodname_dependabot_alerts %}の管理 {% ifversion fpt or ghec %} -You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your personal account. +{% data variables.product.prodname_dependabot_alerts %}は、個人アカウントが所有するすべてのリポジトリで有効化あるいは無効化できます。 -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for existing repositories +### 既存のリポジトリに対する{% data variables.product.prodname_dependabot_alerts %}の有効化あるいは無効化 {% 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. "Code security and analysis(コードのセキュリティと分析)"の下、{% data variables.product.prodname_dependabot_alerts %}の右で**Disable all(すべて無効化)**あるいは**Enable all(すべて有効化)**をクリックしてください。 !["すべて有効化"あるいは"すべて無効化"ボタンが強調された"セキュリティと分析の設定"機能のスクリーンショット](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-all.png) +4. あるいは、作成する新しいリポジトリに対してデフォルトで{% data variables.product.prodname_dependabot_alerts %}を有効化してください。 ![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. **Disable {% data variables.product.prodname_dependabot_alerts %}**もしくは**Enable {% data variables.product.prodname_dependabot_alerts %}**をクリックして、所有するすべてのリポジトリで{% data variables.product.prodname_dependabot_alerts %}を無効化あるいは有効化してください。 ![Screenshot of "Enable Dependabot alerts" with "Enable Dependabot alerts" button emphasized](/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. +既存のリポジトリに対して{% data variables.product.prodname_dependabot_alerts %}を有効化すると、数分の内にGitHub上に結果が表示されます。 -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for new repositories +### 新しいリポジトリに対する{% data variables.product.prodname_dependabot_alerts %}の有効化あるいは無効化 {% 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. "Code security and analysis(コードのセキュリティと分析)"の下、{% data variables.product.prodname_dependabot_alerts %}の右で、作成する新しいリポジトリに対してデフォルトで{% data variables.product.prodname_dependabot_alerts %}を有効化あるいは無効化してください。 ![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) {% 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 %}は、Enterpriseのオーナーが有効化あるいは無効化できます。 詳しい情報については「[EnterpriseでのDependabotの有効化](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)」を参照してください。 {% endif %} ## リポジトリの {% data variables.product.prodname_dependabot_alerts %} を管理する -{% ifversion fpt or ghec %}You can manage {% data variables.product.prodname_dependabot_alerts %} for your public, private or internal repository. +{% ifversion fpt or ghec %}パブリック、プライベート、インターナルリポジトリに対して{% data variables.product.prodname_dependabot_alerts %}を管理できます。 デフォルトでは、新しい{% data variables.product.prodname_dependabot_alerts %}に関して影響を受けるリポジトリに管理権限を持っている人に通知を行います。 {% data variables.product.product_name %} は、特定のリポジトリに対して特定された脆弱性を公表することはありません。 {% data variables.product.prodname_dependabot_alerts %} を、自分が所有または管理者権限を持っているリポジトリで作業している追加のユーザや Team に表示することもできます。 {% data reusables.security.security-and-analysis-features-enable-read-only %} -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for a repository +### リポジトリに対する{% data variables.product.prodname_dependabot_alerts %}の有効化あるいは無効化 {% 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. "Code security and analysis(コードのセキュリティと分析)"の下、{% data variables.product.prodname_dependabot_alerts %}の右で、**Disable(無効化)**あるいは**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) {% 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 %}は、Enterpriseオーナーが有効化あるいは無効化できます。 詳しい情報については「[EnterpriseでのDependabotの有効化](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)」を参照してください。 {% endif %} ## Organization の {% data variables.product.prodname_dependabot_alerts %} を管理する -{% 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. +{% ifversion fpt or ghec %}{% data variables.product.prodname_dependabot_alerts %}は、Organizationが所有するすべてのリポジトリで有効化あるいは無効化できます。 変更はすべてのリポジトリに影響します。 -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for all existing repositories +### 既存のすべてのリポジトリでの{% data variables.product.prodname_dependabot_alerts %}の有効化あるいは無効化 {% 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. "Code security and analysis(コードのセキュリティと分析)"の下、{% data variables.product.prodname_dependabot_alerts %}の右で**Disable all(すべて無効化)**あるいは**Enable all(すべて有効化)**をクリックしてください。 {% 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) {% endif %} @@ -90,16 +90,16 @@ When you enable {% data variables.product.prodname_dependabot_alerts %} for exis ![[Configure security and analysis] 機能の [Enable all] または [Disable all] ボタン](/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. あるいは、Organizationの新規のプライベートリポジトリに対して {% data variables.product.prodname_dependabot_alerts %} をデフォルトで有効にすることもできます。 {% ifversion fpt or ghec %} ![Screenshot of "Enable by default" option for new repositories](/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. **Disable {% data variables.product.prodname_dependabot_alerts %}**もしくは**Enable {% data variables.product.prodname_dependabot_alerts %}**をクリックして、Organizationのすべてのリポジトリで{% data variables.product.prodname_dependabot_alerts %}を無効化あるいは有効化してください。 {% 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) {% 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)." +Organizationに対する{% data variables.product.prodname_dependabot_alerts %}は、Enterpriseのオーナーが有効化あるいは無効化できます。 詳しい情報については「[GitHub Enterprise ServerのDependabotについて](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)」を参照してください。 {% endif %} diff --git a/translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md b/translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md index 42cac17af9..6cbb18c5af 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md +++ b/translations/ja-JP/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/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index e7b22cb72d..908e37f97f 100644 --- a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/ja-JP/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/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 e37e23c8ce..329289c1f7 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 @@ -123,6 +123,7 @@ webhook を保護するためにシークレットが必要なアプリケーシ | [`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 %} | [`プッシュ`](/webhooks/event-payloads/#push) | `contents` | {% data reusables.webhooks.push_short_desc %} | [`リリース`](/webhooks/event-payloads/#release) | `contents` | {% data reusables.webhooks.release_short_desc %} | [`リポジトリ`](/webhooks/event-payloads/#repository) | `メタデータ` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} diff --git a/translations/ja-JP/content/developers/webhooks-and-events/events/github-event-types.md b/translations/ja-JP/content/developers/webhooks-and-events/events/github-event-types.md index b45d76e347..e3358220ad 100644 --- a/translations/ja-JP/content/developers/webhooks-and-events/events/github-event-types.md +++ b/translations/ja-JP/content/developers/webhooks-and-events/events/github-event-types.md @@ -208,6 +208,16 @@ Link: ; rel="next", {% 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 %} + +### イベントの`payload`オブジェクト + +{% data reusables.webhooks.pull_request_thread_properties %} + ## PushEvent {% data reusables.webhooks.push_short_desc %} 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 d3bd686ff0..2ee2cfeb0e 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 @@ -1062,6 +1062,28 @@ GitHub Marketplace の購入に関連するアクティビティ。 {% data reus {{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }} +## pull_request_review_thread + +{% data reusables.webhooks.pull_request_review_thread_short_desc %} + +### 利用の可否 + +- リポジトリ webhook +- Organization webhook +- `pull_requests` 権限のある {% data variables.product.prodname_github_apps %} + +### 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 %} + +### webhook ペイロードの例 + +{{ webhookPayloadsForCurrentVersion.pull_request_review_thread.resolved }} + ## プッシュ {% data reusables.webhooks.push_short_desc %} @@ -1163,7 +1185,7 @@ GitHub Marketplace の購入に関連するアクティビティ。 {% data reus | キー | 種類 | 説明 | | -------- | -------- | ---------------------------------------------------- | -| `action` | `string` | 実行されたアクション. これは次のいずれかになります。
    • 「created」- リポジトリが作成されます。
    • 「deleted」- リポジトリが削除されます。
    • 「archived」- リポジトリがアーカイブされます。
    • 「unarchived」- リポジトリがアーカイブ解除されます。
    • {% ifversion ghes or ghae %}
    • 「anonymous_access_enabled」- リポジトリは [enabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories)、「anonymous_access_disabled」 - リポジトリは [disabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories)
    • {% endif %}
    • 「edited」- リポジトリの情報が編集されます。
    • 「renamed」- リポジトリの名前が変更されます。
    • 「transferred」- リポジトリが転送されます。
    • 「publicized」- リポジトリが公開されます。
    • 「privatized」- リポジトリが非公開になります。
    | +| `action` | `string` | 実行されたアクション. これは次のいずれかになります。
    • 「created」- リポジトリが作成されます。
    • 「deleted」- リポジトリが削除されます。
    • 「archived」- リポジトリがアーカイブされます。
    • 「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」- リポジトリの情報が編集されます。
    • 「renamed」- リポジトリの名前が変更されます。
    • 「transferred」- リポジトリが転送されます。
    • 「publicized」- リポジトリが公開されます。
    • 「privatized」- リポジトリが非公開になります。
    | {% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.org_desc %} {% data reusables.webhooks.app_desc %} diff --git a/translations/ja-JP/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md b/translations/ja-JP/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md index 91201ed046..e381e875ce 100644 --- a/translations/ja-JP/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md +++ b/translations/ja-JP/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md @@ -1,6 +1,6 @@ --- title: Organizationのプロフィールのカスタマイズ -intro: Organizationのプロフィールをカスタマイズすれば、Organizationの情報を共有できます。 +intro: You can share information about your organization by customizing your organization's profile. versions: fpt: '*' ghec: '*' @@ -11,19 +11,69 @@ topics: shortTitle: Organizationのプロフィールのカスタマイズ --- -## OrganizationのプロフィールのREADMEについて +{% if org-profile-pin-private %} -OrganizationのプロフィールのREADMEを作成することで、Organizationとの関わり方に関する情報を共有できます。 {% data variables.product.prodname_dotcom %}は、OrganizationのプロフィールのREADMEをOrgaizationの”Overview(概要)"タブに表示します。 +## About your organization's profile page -OrganizationのプロフィールのREADMEにどういった情報を含めるかは選択できます。 以下は、Organizationのプロフィールの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 %}は、OrganizationのプロフィールのREADMEをOrgaizationの”Overview(概要)"タブに表示します。 + +You can choose what information to include in your organization profile README. Here are some examples of information that may be helpful. - Organizationについて説明する"About"セクション - Organization内で支援を受けるためのガイダンス {% data variables.product.company_short %}フレーバーのMarkdownを使って、OrganizationのプロフィールのREADME内のテキストをフォーマットし、絵文字や画像、GIFを含めることができます。 詳細は「[{% data variables.product.prodname_dotcom %} で書き、フォーマットしてみる](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)」を参照してください。 -## OrganizationプロフィールのREADMEの追加 +## Adding a public organization profile README 1. Organizationがまだパブリックな`.github`リポジトリを持っていないなら、パブリックな`.github`リポジトリを作成してください。 2. Organizationの`.github`リポジトリ内で、`profile`フォルダに`README.md`ファイルを作成してください。 -3. `README.md`ファイルへの変更をコミットしてください。 `README.md`の内容は、Organizationのプロフィールに表示されるようになります。 +3. `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. `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. [**Save pins**] をクリックします。 + +{% endif %} 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/api-previews.md b/translations/ja-JP/content/rest/overview/api-previews.md index 3c97fc7a4c..1d744cbb95 100644 --- a/translations/ja-JP/content/rest/overview/api-previews.md +++ b/translations/ja-JP/content/rest/overview/api-previews.md @@ -4,7 +4,7 @@ intro: API プレビューを使用して新機能を試し、これらの機能 redirect_from: - /v3/previews versions: - ghes: '*' + ghes: <3.4 ghae: '*' topics: - API @@ -47,14 +47,6 @@ Issue またはプルリクエストの[イベントのリスト](/rest/referenc {% endif %} -{% ifversion ghes %} -## pre-receive 環境 - -pre-receive フックの環境を作成、一覧表示、更新、削除します。 - -**カスタムメディアタイプ:** `eye-scream-preview` **発表日:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) -{% endif %} - {% ifversion ghes < 3.3 %} ## プロジェクト @@ -88,7 +80,7 @@ pre-receive フックの環境を作成、一覧表示、更新、削除しま {% endif %} -{% ifversion ghae or ghes %} +{% ifversion ghes < 3.3 %} ## グローバル webhook 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 f22c9ac699..0000000000 --- a/translations/ja-JP/content/rest/reference/secret-scanning.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Secret scanning -intro: Secret scanning APIを使うと、リポジトリのシークレットアラートの取得と更新ができます。 -versions: - 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/data/features/codeql-runner-supported.yml b/translations/ja-JP/data/features/codeql-runner-supported.yml index fe641fe55a..80338055ad 100644 --- a/translations/ja-JP/data/features/codeql-runner-supported.yml +++ b/translations/ja-JP/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/ja-JP/data/features/org-profile-pin-private.yml b/translations/ja-JP/data/features/org-profile-pin-private.yml new file mode 100644 index 0000000000..ebd6681081 --- /dev/null +++ b/translations/ja-JP/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/ja-JP/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md b/translations/ja-JP/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md new file mode 100644 index 0000000000..a5d5d32384 --- /dev/null +++ b/translations/ja-JP/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. 詳細は「[{% 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/ja-JP/data/reusables/code-scanning/alerts-found-in-generated-code.md b/translations/ja-JP/data/reusables/code-scanning/alerts-found-in-generated-code.md new file mode 100644 index 0000000000..c9ac4a57f2 --- /dev/null +++ b/translations/ja-JP/data/reusables/code-scanning/alerts-found-in-generated-code.md @@ -0,0 +1,3 @@ +Java、C、C++、C# などのコンパイルされた言語の場合、{% data variables.product.prodname_codeql %} はワークフローの実行中に作成されたすべてのコードを分析します。 分析するコードの量を制限するには、`run` ブロックで独自のビルドステップを指定して、分析するコードのみをビルドします。 独自のビルドステップの指定と、`pull_request` および `push` イベントの `paths` または `paths-ignore` フィルタの使用を組み合わせて、特定のコードが変更されたときにのみワークフローが実行されるようにすることができます。 詳細については、「[{% data variables.product.prodname_actions %}のワークフロー構文](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)」を参照してください。 + +ソースコードをコンパイルすることなく {% data variables.product.prodname_codeql %} が分析する Go、JavaScript、Python、TypeScript などの言語の場合、追加の設定オプションを指定して分析するコードの量を制限できます。 詳しい情報については、「[スキャンするディレクトリを指定する](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/webhooks/pull_request_review_thread_short_desc.md b/translations/ja-JP/data/reusables/webhooks/pull_request_review_thread_short_desc.md new file mode 100644 index 0000000000..7d835cbe5a --- /dev/null +++ b/translations/ja-JP/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/ja-JP/data/reusables/webhooks/pull_request_thread_properties.md b/translations/ja-JP/data/reusables/webhooks/pull_request_thread_properties.md new file mode 100644 index 0000000000..6336713b64 --- /dev/null +++ b/translations/ja-JP/data/reusables/webhooks/pull_request_thread_properties.md @@ -0,0 +1,5 @@ +| キー | 種類 | 説明 | +| -------------- | -------- | ----------------------------------------------------------------- | +| `action` | `string` | 実行されたアクション. 次のいずれかになります。
    • `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` | `オブジェクト` | The [pull request](/rest/reference/pulls) the thread pertains to. | +| `スレッド` | `オブジェクト` | The thread that was affected. | diff --git a/translations/log/ja-resets.csv b/translations/log/ja-resets.csv index 7031c17589..bc980b556c 100644 --- a/translations/log/ja-resets.csv +++ b/translations/log/ja-resets.csv @@ -115,6 +115,7 @@ translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scannin translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md,broken liquid tags translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md,broken liquid tags translations/ja-JP/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md,broken liquid tags +translations/ja-JP/content/code-security/dependabot/dependabot-alerts/browsing-security-vulnerabilities-in-the-github-advisory-database.md,broken liquid tags translations/ja-JP/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md,broken liquid tags translations/ja-JP/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md,broken liquid tags translations/ja-JP/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md,broken liquid tags 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 65064bcf6a..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,12 +16,12 @@ 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 %} -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. +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 %} -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 %}. 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)". +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 %} 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/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 7adf2c01fc..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)." 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/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/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 f9a70cae83..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 @@ -114,7 +114,7 @@ topics: {%- 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 %} @@ -128,64 +128,64 @@ topics: {%- ifversion ghes %} | `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` | 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` | 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/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/viewing-and-updating-dependabot-alerts.md b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 54791d31e6..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 @@ -94,9 +94,9 @@ Para obter mais informações, consulte "[Eevisando e corrigindo dependências v É 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. Se você tiver {% data variables.product.prodname_dependabot_security_updates %} habilitado, o pull request poderá estar vinculado ao alerta do Dependabot. +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. 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. +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 %} 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 04c18ad4a2..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 @@ -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 %} 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 fd2a663ca2..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 @@ -65,32 +65,32 @@ Para obter mais informações sobre esse comando, consulte [o manual de{% data v {% 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/getting-started/quickstart.md b/translations/pt-BR/content/codespaces/getting-started/quickstart.md index f9637acbd5..5a7022695b 100644 --- a/translations/pt-BR/content/codespaces/getting-started/quickstart.md +++ b/translations/pt-BR/content/codespaces/getting-started/quickstart.md @@ -27,7 +27,7 @@ Para obter mais informações sobre exatamente como {% data variables.product.pr 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-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/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/configuring-prebuilds.md b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 0bd17ea38c..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 @@ -62,7 +62,7 @@ Antes de configurar as pré-compilações para seu projeto, os pontos a seguir d 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. 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. + * **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 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 2f357eab91..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 @@ -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/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 7194ee06d4..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 %} 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/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/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 37d125e21b..0000000000 --- a/translations/pt-BR/content/rest/reference/secret-scanning.md +++ /dev/null @@ -1,13 +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: - 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/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/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/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/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/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/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 84f4e446e3..0000000000 --- a/translations/zh-CN/content/rest/reference/secret-scanning.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 秘密扫描 -intro: 使用机密扫描 API 从存储库中检索和更新机密警报。 -versions: - 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 +---